meetkool / college-management

Axios: College management portal

College Management - IIIT Lucknow

Introduction

Configuration

1. First, make sure you have Node.js and npm (Node Package Manager) installed on your computer, You can check this by running the following commands in your terminal:

    node -v
    npm -v

Read docs here Node.js Documentation

2. Once you have npm installed you can run the following both to install and upgrade Yarn

    npm install --global yarn
    yarn --version

Read docs here: Yarn Installation guide

Installation

1. Fork the repo

Read docs here: Forking a repo

2. Clone the project from the forked repo

    git clone https://github.com/<username>/<fork-name>

3. Once the project is cloned, navigate into the project directory and run the following command to install all the necessary dependencies:

    yarn install

4. Finally, to start the development server, run the following command in your terminal:

    yarn start

This will start the development server - you should be able to see your client running at http://localhost:3000, the server running at http://localhost:5000