🚀 Technologies

🚀 Features

User SignIn / SignOut;
Create / update / soft delete Customers;
Create / update / delete products;
Create / update / delete product categories;
Create delivery / pickup orders;
Close delivery / pickup orders;
Delete open orders;
Edit profile;
Create new user;

👷 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/johnfreitasau/sweetcake-web.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:johnfreitasau/sweetcake-web.git

Install dependencies

yarn install

Create your enviroment 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.

Setup the API

The interface needs to interact with the server to receive and register data.

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

🏃 Getting Started

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

yarn start

📮 Faq

Question: What are the tecnologies used in this project?

Answer: The tecnologies used in this project are React + Styled Components to handle scoped CSS.

🐛 Issues

Feel free to file a new issue with a respective title and description on the sweetcake 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

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