This is the admin dashboard and backend server for the QR Docent app.
To start development you need to have Node.js and Yarn installed. (Node.js is a JS runtime and Yarn is a package manager)
Initial steps:
- Fork the repo
- Clone your fork
- Add the main repo as upstream (
git remote add upstream https://github.com/daviddecorso/QRDocentDashboard
) - Run
yarn
(this should be done after every pull in case new dependencies are added.) - Use
yarn vercel dev
to run a development server. (Hosted on http://localhost:3000)
Contributing:
- Get the latest work from the repo:
git pull upstream main
(alternatively you can usegit fetch
if you don't want to make changes locally). - Make a new branch to start working:
git checkout -b branch-name
(to move to an existing branch dogit checkout branch-name
) - Do your work, commit (
git commit -m "message"
), push that branch (git push upstream branch-name
), and open a pull request on the main repo.