luizsandoval / appizza Goto Github PK

Status: Under improvement 🚧 (version 2 is coming)🚀

👨‍🏫 Overview

💡 Functionalities

🚀 Preview

🔧 Running locally

📦 Technologies Used

Who doesn't love pizza 🍕 ❤️?

But, did you ever gave up on ordering a pizza or cancelled your order because you had to call to the pizza place, wait to be attended and then make your order? 😨

So, put a smile on your face because I have great news for you 💃!

Appizza simulates an environment where you can make and follow up your order in just a few clicks, without any headache ☺️.

✔️ User register & login

✔️ Responsive layout

✔️ Manage pizza orders

✔️ Manage pizzas (insert, read, edit and even delete)

A demonstration of Appizza is available on the link below. Feel free to access and play with it:

🔗 Appizza

You can also run it locally if you want, these at the steps that you need to take first:

• ⚠️ Node
• ⚠️ Yarn

You can use NPM, but I recommend using Yarn because the project lockfile was generated using it

On the terminal, run the following command:

git clone https://github.com/luizsandoval/appizza.git

After cloning the repo, open it on your terminal and you will find two folders:

• api: that's the application backend.
• app: that's the application frontend.

You will need to install dependencies for both parts of the app.

On the terminal, make sure you are on the repository root folder and run the following command:

    cd api

Once inside the api folder, install the necessary dependencies:

Recommended

    yarn install

or

    npm install

As we use SQLite as database, we need to setup it before running our api. Fortunately, I have made this easy for you, just run the following command:

    yarn database

or

    npm database

Before executing the api, you will need to create a .env file on the root of the api folder, with the following content:

    IMAGES_URL=http://localhost:3333/uploads
    SECRET_JWT=<your secret here>
    NODE_ENV=DEV
    PORT=3333

⚠️ Don't forget to setup your secret to guarantee that JWT will work as expected

Finally, we can start the api by simple running:

    yarn start:dev

or

    npm run start:dev

Now, let's setup the frontend.

Ensure that you are at the repository root folder and enter on the app folder:

    cd app

Once there, run the following command to install the necessary dependencies:

    yarn install

or

    npm install

Now, before executing the application, you need to create a .env file on the root of the app folder, with the following content:

    REACT_APP_API_URL=http://localhost:3333

Once you create that file, you are ready to go 😎! Just run:

    yarn start

or

    npm start

And your default browser will open the app at http://localhost:3000.

• Express
• Knex
• SQLite

• React
• Styled Components
• React Dropzone
• React Hook Form

Luiz Sandoval

The MIT License (MIT)

Copyright ©️ 2020 - Appizza - App for pizza places.

Made with ❤️ by Luiz Sandoval