DsDelivery API

Chose your plate, set the address and place the order

📌 Table of Contents

• Features
• Requirements
• Installation
• Getting Started
• FAQ
• Found a bug? Missing a specific feature?
• Contributing
• License

🚀 Features

• Pick one plate or more and place the order

It's important to mention that this is one of the applications from the DsDelivery System

In order to explore the others, feel free to click on the link below:

• DsDelivery API

Requirements

For building and running the application you need:

• Node and npm

👷 Installation

To install this application, run the following commands:

git clone https://github.com/iamgrodrigues/dsdelivery-web.git

If you have a SSH key registered in your Github account, clone the project using this command:

git clone [email protected]:iamgrodrigues/dsdelivery-web.git

Installing npm packages

To install npm packages described in the package.json run this command:

npm install

Create your own enviroment variables based on the example file .env.example

cp .env.example .env

After copying the example, make sure to fill out the variables with your own values.

🏃 Getting Started

Running the Application Locally

Run the following command:

npm start

After the above command, you can navigate to the following address to see the project up and runnig:

http://localhost:3000/

Note: The app will automatically reload if you change any of the source files.

Setting up the API

The interface needs to interact with the server to get all the data related to the products.

Make sure to go to the DsDelivery API repository and follow the instructions in order to get it running on your machine.

📮 Faq

Question: What are the tecnologies used in this project?

Answer: The tecnologies used in this project are Typescript + React + Html + Css.

🐛 Issues

Feel free to file a new issue with a respective title and description on the the DsDelivery WEB 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 2021. This project is under the MIT license.

Made with love by Guilherme Rodrigues 💚🚀