Giters

krish-17 / Enviclean_Backend

This is the backend of an web based garbage pickup website designed and developed from the scratch by a team of five members. This contains the server code logic of it. The application follows modern web application coding structure. It is an express application

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

CSCI5709 Project - Advanced Topics in Web Development

EnviClean API

Keeping the environment clean is our motive. Hence the project name EnviClean. It is a garbage collection management system developed by Advanced Web Services - Group 6. In this project we have developed the back-end APIs for EnviClean web application.

  • Date Created: 15 07 2021
  • Last Modification Date: 21 07 2021

Links

Authors

Getting Started

This back-end is created using Node JS and Express JS.

Prerequisites

To have a local copy of this project up and running on your local machine, you will first need to install the following software/libraries/plugins

  • Node - Download and install Node, which also includes NPM(Node Package Manager). Alternative to Node + NPM is Yarn.
  • Visual Studio Code - Download and install VS Code or any Editor/IDE(Integrated Development Environment) of your choice. - Optional

See the following section for detailed step-by-step instructions on how to install this software/libraries/plugins.

Installing

A step by step series of examples that tell you how to get a development env running. Let's use Node + NPM for this project.

  • Head to the official Node website to download and install Node, which also includes NPM.
  • Select the "Recommended For Most Users" button and download the current version for your Operating System.
  • After you download and install Node, open command prompt/terminal and run the following commands to check if everything works:
    • node -v
    • npm -v
  • To run the application, change to the directory where the app was installed using "cd <folder_name>".
  • Run "npm install" to install all the dependencies used by the app.
  • Finally, run "npm run dev" to see the app live on the localhost.

Available Scripts

npm run dev

Runs the app in the development mode. The APIs will run on port 3001 on localhost.

Built With

Instructor

About

This is the backend of an web based garbage pickup website designed and developed from the scratch by a team of five members. This contains the server code logic of it. The application follows modern web application coding structure. It is an express application

Languages

Language:JavaScript 100.0%