FastFeet Shipping Company

---

This project is about a shipping company.

📝 Table of Contents

• About
• Getting Started
• Deployment
• Usage
• Built Using
• Authors
• Acknowledgments

🧐 About

This api is to serve the fastfeet app mobile and web.

🏁 Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

• A MongoDB Database (MongoDB Atlas or Docker Mongo)
• A PostgreSQL Database (PostgreSQL or Docker PostgreSQL)
• Redis (Redis or Docker Redis)
• Insomnia REST Client (Insomnia)
• Node installed (Recommend LTS)
• Yarn or Npm (Just install Node)

Installing

You need create a database PostgreSQL, MongoDB and Redis to run backend

# Creating a postgreSQL database in Docker
docker run --name fastfeet_db -e POSTGRES_PASSWORD=yuor password -p 5432:5432 -d postgres

# Creating a mongo database in Docker
docker run --name fastfeet_mongo -p 27017:27017 -d -t mongo

# Creating a redis database in Docker
docker run --name redisfastfeet -p 6378:6379 -d -t redis:alpine

# Clone this repository
$ git clone https://github.com/arllain/fastfeet-api.git

# Go into api
$ cd fastfeet-api

# Install dependencies
$ yarn

# Execute migrations
$ yarn sequelize db:migrate

# And execute seeds
$ yarn sequelize db:seed:all

# Run the api
$ yarn dev

# Debug the api
$ yarn dev:debug

🔧 Running the tests

Explain how to run the automated tests for this system.

Break down into end to end tests

Explain what these tests test and why

Give an example

And coding style tests

Explain what these tests test and why

Give an example

🎈 Usage

Add notes about how to use the system.

🚀 Deployment

Add additional notes about how to deploy this on a live system.

⛏️ Built Using

• Express - Server Framework
• NodeJs - Server Environment
• Sucrase - Sucrase
• Nodemon - Nodemon
• prettier - Prettier
• eslint - eslint
• eslint-config-prettier - eslint Config Prettier
• eslint-plugin-import - eslint plugin import
• eslint-plugin-prettier - eslint plugin prettier
• eslint-config-airbnb-base - packageseslint-config-airbnb-base
• Sequelize - Sequelize
• sequelize-cli - sequelize-cli
• pg-hstore - pg-hstore
• bcryptjs - bcryptjs
• jsonwebtoken - jsonwebtoken
• yup - yup
• multer - multer
• date-fns - date-fns
• mongoose - mongoose
• nodemailer - nodemailer
• nodemailer-express-handlebars - nodemailer-express-handlebars
• express-handlebars - express-handlebars
• bee-queue - bee-queue
• sentry - sentry
• express-async-errors - express-async-errors
• youch - youch
• dotenv - dotenv

✍️ Authors

• @arllain