Skip to content

Latest commit

 

History

History
executable file
·
95 lines (62 loc) · 3.28 KB

README.md

File metadata and controls

executable file
·
95 lines (62 loc) · 3.28 KB
Raw

Starware

Logo

Project Dates

Forks Stargazers Issues MIT License

About

This is the dashboard repository for managing the Avenue app, a campus guide for NIT Rourkela. It is a respository managing the API for managinng, controlling and authorising the users with respect to the mobile application of Avenue.

Project developed and maintained by DSC NIT Rourkela

Tech Stack

This project uses the following technologies :

  • react
  • next.js
  • yarn
  • material ui

Local Setup

This section contains the procedure to setup the project on your local machine.

PREREQUISITE INSTALLATIONS

  1. Docker
  2. Docker Compose

Node.js required only for linting locally

  1. Fork the repo on GitHub
  2. Clone the project to your own machine
  3. Prepare the env for project.

cd api && mv .env.example .env

  1. Add Mongo DB URI in .env file
  2. Build the docker image

docker-compose build --no-cache

  1. Spin the server.

docker-compose up

Documentation Notes

This section contains a quick guide about the features of the application.

Contributing 🎃

This repository is one of the many repositories maintained by DSC NIT Rourkela NIT Rourkela.
Our Slack Community: Slack Invite

Please refer to the project's style and contribution guidelines for submitting patches and additions. In general, we follow the "fork-and-pull" Git workflow.

NOTE 1: Please abide by the Contributing Guidelines.

NOTE 2: Please abide by the Code of Conduct.

Starware

dscnitrourkela/project-dates is Starware. This means you're free to use the project, as long as you star its GitHub repository. Your appreciation makes us grow and glow up. 🌠