README English.md

Project Name {#project_name}

Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots in a piece of classical Latin literature from 45 BC, making it over 2000 years old.

💻 About - 🎨 Layout - 🛠 Technologies - 💿 How to Run - 🧪 Demo - 🙋‍♂️ Contributors - 🦸 Author - 📝 License

💻 About the Project {#about}

Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots in a piece of classical Latin literature from 45 BC, making it over 2000 years old.

🎨 Layout {#layout}

The layout of the application is available on Figma:

🛠 Technologies {#technologies}

The following tools were used to build the project:

• tech 1
• tech 2
• tech 3

See the file package.json

Utilities

• Prototype: Figma → Prototype (Project Name)
• API: Example API 1 → Example API 2, Example API 3
• Editor: Visual Studio Code
• Icons: Icons 1, Icons 2
• Fonts: Font 1, Font 2

💿 How to Run {#how-to-run}

🧰 Prerequisites

Before you begin, you will need to have the following tools installed on your machine:

Git, Node.js or Yarn if that's your preference. Additionally, it's good to have an editor to work with the code, such as VSCode

🧭 Running the Project

# Clone this repository
$ git clone <https://github.com/<github_user>/<project_name>

# Navigate to the project folder in terminal/cmd
$ cd <project_name>

# Install dependencies (npm or yarn)
$ yarn

# Run the application in development mode
$ yarn dev

# Access http://localhost:3000

🧪 Demo {#demo}

🙋‍♂️ Become a Contributor {#contributors}

Want to be a part of this project? Click HERE and read how to contribute.

🦸 Author {#author}

Jhon Doe

📝 License {#license}

Distributed under the MIT License. See the LICENSE for more information.

Made with ❤️ by Jhon Doe 👋🏽 Get in touch!

⬆ Back to top

Choose your language: 🇧🇷 🇺🇸