Skip to content

raghav4/yearbook-backend

Repository files navigation

Backend of Yearbook Project

Backend Application of Yearbook

API Documentation

documentation

https://documenter.getpostman.com/view/6857431/Szmb7zkd

Please ensure you have the following installed

  • node.js v12.14.1
  • npm v6.14.2
  • mongodb

Installation & Setup Guide

# Clone the repoisotry
git clone https://github.com/raghav4/yearbook-backend.git`

# Change the current working directory
cd yearbook-backend

# Install all the dependencies
npm install

# Create a '.env' file same as that of '.env.example' and
# Add some custom environment variables similar to '.env.example'
touch .env

# Run the development server
npm run dev

# Stop the server using 'ctrl + c'

Creating Super Admin

# Create the super admin using the command
npm run add-admin