README.md

Pi Smart Storage

Web project from the Integrated project of the college.

📌 Table of Contents

• About The Project
• Technologies
• Getting Started
  • Prerequisites
  • Installation
  • Usage
• License

📝 About The Project

Web project from the Integrated project of the college, to manage stock. Development with ReactJs, NextJs and prisma.

💻 Technologies

This project was developed with the following technologies:

• React
• Typescript
• Tailwind CSS
• Prisma

🏃 Getting Started

To run the project locally follow these steps:

⚠️ Prerequisites

• NodeJs Prefer to install the LTS version.
• Yarn Need to install latest version prior to 2.0 version.

👷 Installation

1. To clone the project, run this command:

git clone https://github.com/arrudadev/pi-smart-storage.git

2. Install dependencies:

yarn install

🤘 Usage

1. 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.

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

yarn dev

3. Open the project into your browser in:

http://localhost:3000

📄 License

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