Slime Shop API

A back-end rest API of a slime shopping application

Click here to see the database model

📌 Table of Contents

• Project Status
• Features
• Installation
• Getting Started
• Found a bug? Missing a specific feature?
• Contributing
• License

✔️ Project Status

🚧 Slime Shop backend ✔️ Done ✔️

🚀 Features

• Query products in the database

👷 Installation

You need to install Node.js and Yarn first, then in order to clone the project via HTTPS, run this command:

git clone https://github.com/kellina/loja-slime-back.git

SSH URLs provide access to a Git repository via SSH, a secure protocol. If you have a SSH key registered in your Github account, clone the project using this command:

git clone git@github.com:kellina/loja-slime-back.git

Install dependencies

npm install

Setup a database

1. Install the postregres and create a database.

2. This tutorial may help you

3. Connect the database and run the SQL script /src/scripts/slime-shop.sql to create the tables

4. To show the tables, type \dt

Configure environment variables

Create your environment variables based on the examples of .env.example

cp .env.example .env

After copying the examples, make sure to fill the variables with new values.

🏃 Getting Started

Run the following command in order to start the application in a development environment:

 // Start the server
  npm start

🪲 Issues

Feel free to file a new issue with a respective title and description on the the Slime Shop API repository. If you already found a solution to your problem, I would love to review your pull request! Have a look at our contribution guidelines to find out about the coding standards.

🎉 Contributing

Check out the contributing page to see the best places to file issues, start discussions and begin contributing.

📕 License

Released in 2020. This project is under the MIT license.