Skip to content

Latest commit

 

History

History
97 lines (68 loc) · 2.44 KB

README.md

File metadata and controls

97 lines (68 loc) · 2.44 KB

Hand Me Ups

Live site: https://hand-me-ups.herokuapp.com/

Description

Table of Contents

  1. Installation
  2. Usage
  3. License
  4. Contributing
  5. Questions

1 Installation

  1. Start by installing front and backend dependencies. While in the root directory, run the following command:
npm run install

This should install node modules within the server and the client folder.


  1. [Optional] If you will contribute to the repository initialize Eslint.
npm run lint

  1. Set up the environmental (.env) file
cp .env.template .env

Add your api keys to the .env file


  1. Set up the config (config.json) file
cp config/config.json.template config/config.json

Adjust the login and server settings as necessary


  1. Seed the database with the initial dataset
  • On your PostgreSQL server create databases: handmeups and handmeups_test

Seed your database

npm run seed

  1. After configuration and installation is complete, run the following command in your terminal:
npm start

  1. Your app should now be running on http://localhost:3000. The Express server should intercept any AJAX requests from the client.

2 Usage

3 License

Copyright © 2020 Hand Me Ups
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

4 Contributing

5 Questions