Follow this quick guide to set up the project for local development.
Before you begin, make sure you have the following installed on your system:
- Node.js 12.x (Recommended: use Nvm for managing Node versions)
- MongoDB 3.6.x
Regarding your development environment: I highly recommend you to use VSCode with the Prettier and EsLint plugins installed. This way your code can be automatically fixed on save, according to the eslint/prettier configuration defined in the project. The project will not allow commits that do not pass the linter.
git clone https://github.com/hackjunction/hackplatform.git
cd hackplatform
This is a monorepo consisting of a backend, frontend and shared folder, which all need to be installed separately. For convenience, there exists a setup script in the root-level package.json, which does that for you. To set up the project, just run (in the root folder):
npm install
npm run setup
To be able to run the project, you'll need to set up some environment variables. Follow the instructions in ENV.md to do that.
Running the project in development mode requires running the React dev server and the Node.js backend concurrently. For convenience, there exists a dev script in the root level package.json which does that for you. So, to spin up both servers just run:
npm run dev
The app will automatically reload when you make changes to the code. Note: starting up the React development server will take some time on first startup, depending on the machine your working on, so be patient with it. Consequent code changes should reload the app quickly.
The development version of Auth0 will automatically grant all permissions to users who sign up. When you create a new user in the app, you should by default have access to e.g. create new events on the organiser dashboard under /organise.