SETUP.md

SETUP

To setup a local development environment, follow the steps given below.

1. Ensure you have NodeJS, npm installed in your system.
2. Fork and then clone the repository

$ git clone https://github.com/<your-username>/CA-Website.git

3. From the root folder, Install dependencies in client folder.

$ cd client
$ npm i
$ npm start

4. From the root folder, Install dependencies in server folder. Generate environment variables and fill in the values.

$ cd server
$ npm i
$ cp .env.sample .env
$ npm run dev

5. At the end of this, you should have server running at http://localhost:8000 client running at http://localhost:3000

Repository structure

Our repository is structured as follows

.
├── client
│   ├── public
│   └── src
│      
└── server
    ├── src
    └── test
    

Bug/ Feature Request

Now that the development environment is all set up, head over to Contributing to learn how to contribute.