Here is the procedure on how to work with the GitHub repo, when you want to start coding:
- Fork the origin repo to your
PERSONAL PRIVATE repo - Working on your new repo, (usually you wanna check out a few feature branches thus to keep the default branch easy to sync and merge from - it is a bit tricky)
- When your code is ready to merge, pls create a PULL REQUEST from your repo to the origin repo
- Before merging, pls make sure you have run the following commands:
and then commit the changes to the PR
npm run build - Once the PR is approved, it will be merged into the origin repo
- Once the PR is merged, you can delete your PR branch
- branch: use
developbranch as default - Keep the code clean, style consistent
- Try to use the dependent libraries we provide. If you have special needs, please contact @jhcao23 or @keyskull
- Always think about code reusability
- Pls let us know if you have any questions about this procedure
- copy the
dev.next.config.js.samplefile todev.next.config.js
Initial your project with the following commands:
git submodule update --init
npm installFinally, run the following commands to start the development server:
npm run devPlease make sure your code is locally built correctly
!!! Before your git push, use the command: npm run build to make sure the code you build is not in conflict.
Then use regular git operation to submit your code.
You should now be able to access the application at http://localhost:3000. Make sure you haven't run multiple instances for the same application at the same time.
Thanks!