Skip to content

Latest commit

 

History

History
70 lines (51 loc) · 1.8 KB

README.md

File metadata and controls

70 lines (51 loc) · 1.8 KB


sustainship
sustainship

An intuitive web interface to coordinate package shipments and reduce carbon emissions

Key Features • How To Use • License

landing Landing Page

Key Features

  • User and Employee Auth
  • Delivery driver portal
    • Displays all information related to submitted orders and group shipments, including carbon emissions savings
    • Shipments filterable by postal code
  • User portal
    • Shows all submitted orders with expected carbon emissions savings
    • Orders filterable by date
    • Seamless submission form

How To Use

To clone and run this application, you'll need Git and Node.js (which comes with npm) installed on your computer. From your command line:

# Clone this repository
$ git clone https://github.com/mslwang/sustainship.git

# Go into the backend directory in the repository and install dependencies
$ cd sustainship/backend 
$ npm install

# Store your mongodb uri into a .env file with env variable name MONGO_URI
$ echo MONGO_URI=`insert mongodb uri` > .env

# Go into the client directory and install dependencies
$ cd ../client
$ npm install

# Run the app
$ npm start

Technologies

This software uses the following technologies:

License

MIT