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 cp .env.example .env.local and set up env variables
• 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

Further reading

• Git Flow
• Conventional Commits

Built with

• Next.js
• Drizzle ORM
• TailwindCSS

Project Guideline

Your project's readme is as important to success as your code. For this reason you should put as much care into its creation and maintenance as you would any other component of the application.

If you are unsure of what should go into the readme let this article, written by an experienced Chingu, be your starting point - Keys to a well written README.

And before we go there's "one more thing"! Once you decide what to include in your readme feel free to replace the text we've provided here.

Own it & Make it your Own!

Team Documents

You may find these helpful as you work together to organize your project.

• Team Project Ideas
• Team Decision Log

Meeting Agenda templates (located in the /docs directory in this repo):

• Meeting - Voyage Kickoff --> ./docs/meeting-voyage_kickoff.docx
• Meeting - App Vision & Feature Planning --> ./docs/meeting-vision_and_feature_planning.docx
• Meeting - Sprint Retrospective, Review, and Planning --> ./docs/meeting-sprint_retrospective_review_and_planning.docx
• Meeting - Sprint Open Topic Session --> ./docs/meeting-sprint_open_topic_session.docx