Chingu Project

Prerequisites

Make sure you have the following installed in your system:

• Node.js
• Git
• pnpm

Getting Started

• Create a fork of the repo
• Clone your forked repo locally git clone <repo_link>
• cd into the cloned directory

• Run pnpm install to install all the dependencies
• Create an upstream to the main repo git remote add upstream https://github.com/chingu-voyages/v46-tier3-team-28.git
• To update your fork with the main repo run git pull upstream main. Make sure you update your repo regularly to keep up with the main repo.
• Create a new branch git checkout -b <branch_name>
• Run pnpm dev and start developing

IDE Integration with Prettier

• Install the "Prettier - Code formatter" extension for VS Code.
• Open VS Code settings (Ctrl+ (Windows/Linux), or Cmd+ (Mac),).
• Search for "Editor: Default Formatter" and select it. Choose "Prettier - Code formatter" as the default.
• Search for "Editor: Format On Save" and enable it to automatically format your code when you save.
• Optionally, specify the path to your .prettierrc.js configuration file by searching for "Prettier: Config Path" and adding the path.

Important Docs

• Team decision Doc
• Design Doc
• Figma Design

Further reading

• Git Flow
• Conventional Commits

Built with

• Next.js
• Drizzle ORM
• TailwindCSS

🎨 Demo

Check out the website: DEMO

👩🏽‍💻 Contributing

• Contributions make the open source community such an amazing place to learn, inspire, and create.
• Any contributions you make are greatly appreciated.
• Check out our contribution guidelines for more information. (wip⚙️)

👨‍👩‍👦 Community

Don't forget to join the community - Join us

💪🏽 Thanks to all Contributors

Thanks a lot for spending your time helping our project grow. Thanks a lot! Keep rocking🍻