Skip to content

Latest commit

 

History

History
90 lines (52 loc) · 2.36 KB

README.md

File metadata and controls

90 lines (52 loc) · 2.36 KB
Raw

Gift Recommender - Backend

Build Status

Discover FANTASTIC GIFTS for friends and family. Built for lazy people that want to dazzle their loved ones.

Feature List

  • Search for Gift Ideas based on Budget
  • View Purchase links for Gift Ideas
  • Explore Gift Ideas
  • Contribute Gift Suggestions

This project assumes you have Git installed.

Setup

For developers to get started with this project, you'll need to create a local copy of the project.

Run the following in your terminal:

 git clone https://github.com/ajibs/gift-recommender-service.git

Then change into the local directory, run the following in your terminal:

cd gift-recommender-service

Docker

You'll need to have Docker installed to proceed with setting up the project.

To start a docker container for Gift Recommender Service, run this command in the terminal:

./start_container.sh

N/B: You might have permission problems on a Unix, please visit the following link to resolve potential file permission issues.

The start container script will link you to the bash terminal of a running container.

You can then proceed to the Development Section or the Linting & Tests Section to run sample code.

Development

To kickstart the application, run the following in your terminal:

npm run dev

Linting and Tests

You can run linting and unit/regression tests by running the following in your terminal:

npm run test:all

Tech Stack

  • Git - Version Control
  • Node.js - JS Runtime Environment
  • npm - Package Manager
  • Express - Web Framework
  • Mocha - Testing Framework
  • MySQL - Database
  • Heroku - Hosting and Continuous Deployment

Contributing

Contributions are welcome

Authors

License