Steps to run the repo locally
- Git Clone the repo to your machine
- Download Node(18.20.4) and npm/bun
- Recommend Using nvm https://github.com/nvm-sh/nvm but not neccessary
- Copy .env.example and name it .env
- Download Postgresql and start a server on your machine
- Add posgresql connection string from the server you just created to .env and replace the DATABASE_URL
- run bunx/npx prisma db push
- run npm install/bun install
- run npm run dev/bun run dev
- Should see the purple create t3 App screen
- run bunx/npx prisma studio
- Should see the Prisma studio screen
Other stuff to set up if you have time can look for guides online or ask in the chat.
- Eslint
- Prettier
Once done, Add your name below and refer to the contribution guide below to push it(this will be the rough workflow we will go through for all our work).
Done:
- Zi Yang
- Ernest
- Chuan Xin
- Keith
Contribution Guide: refer to https://rogerdudler.github.io/git-guide/ for basic git usage Create a branch and name it yourname/branchname. Push changes to your to your new branch (make sure your on your new branch) Once done, create a merge request to main.
This is a T3 Stack project bootstrapped with create-t3-app
.
We try to keep this project as simple as possible, so you can start with just the scaffolding we set up for you, and add additional things later when they become necessary.
If you are not familiar with the different technologies used in this project, please refer to the respective docs. If you still are in the wind, please join our Discord and ask for help.
To learn more about the T3 Stack, take a look at the following resources:
- Documentation
- Learn the T3 Stack — Check out these awesome tutorials
You can check out the create-t3-app GitHub repository — your feedback and contributions are welcome!
Follow our deployment guides for Vercel, Netlify and Docker for more information.