felipeDS91 / goldman-backend

💍 Rest api of goldman application - made with with express framework - using docker, MysSQL and sequelize

Express Application for a Goldman Web App

About the project   |    Technologies   |    Getting started   |    How to contribute   |    License

👨🏻‍💻 About the project

Goldman is a web software develop to help companies of jewels. Thinking about helping them, I developed this API so the company can have a simple and easy way to control and visualize the orders.

The company can register customers, payment types, statuses, materials, carriers and types of freight to manage their orders.

To see the web client, click here: Goldman Frontend

🚀 Technologies

Technologies that I used to develop this api

• Node.js
• Express
• Sequelize
• Yup
• JWT-token
• MySQL
• Date-fns
• Jest
• SuperTest
• Faker
• Eslint
• Prettier
• EditorConfig

💻 Getting started

Import the Insomnia.json on Insomnia App or click on Run in Insomnia button

Requirements

• Docker
• Node
• Yarn

Clone the project and access the folder

$ git clone https://github.com/felipeDS91/goldman-backend.git && cd goldman-backend

Follow the steps below

# Install the dependencies
$ yarn

# Make a copy of '.env.example' to '.env'
# and set with YOUR environment variables
$ cp .env.example .env

# Creates a docker container (changes the password)
$ docker run --name "goldman"  -e MYSQL_ROOT_PASSWORD="mysql_password" -p 3306:3306 -d mysql:5.7.30

# Creates a new mysql user (changes the username and password)
# To connect with mysql database you can use a tool like DBeaver for example
$ CREATE USER 'username'@'localhost' IDENTIFIED BY 'password';

# Once the services are running, let's find the CONTAINER_ID
$ docker ps
# And then replace it into the command to enter in Linux bash
$ docker exec -it [CONTAINER_ID] /bin/bash

# Once in the linux bash, run the migrations
$ yarn sequelize db:migrate

# So, run the seeds to create admin user and some data
$ yarn sequelize db:seed:all

# Credentials:
# email: [e-mail]
# password: 123456

# Well done, project is started!

🤔 How to contribute

• Make a fork of this repository

# Fork using GitHub official command line
# If you don't have the GitHub CLI, use the web site to do that.

$ gh repo fork felipeDS91/goldman-backend

# Clone your fork
$ git clone your-fork-url && cd goldman-backend

# Create a branch with your feature
$ git checkout -b my-feature

# Make the commit with your changes
$ git commit -m 'feat: My new feature'

# Send the code to your remote branch
$ git push origin my-feature

After your pull request is merged, you can delete your branch

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

---

Made with 💜  by Felipe Douglas 👋 See my linkedin