An open API service indexing awesome lists of open source software.

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

Web project from the Integrated project of the college.
https://github.com/arrudadev/pi-smart-storage

nextjs prismajs reactjs tailwindcss

Last synced: 3 months ago
JSON representation

Web project from the Integrated project of the college.

Awesome Lists containing this project

README

        





Pi Smart Storage


Web project from the Integrated project of the college.

[![License: MIT](https://img.shields.io/badge/License-MIT-brightgreen.svg)](https://opensource.org/licenses/MIT)


cover

:pushpin: Table of Contents

* [About The Project](#about-the-project)
* [Technologies](#technologies)
* [Getting Started](#getting-started)
* [Prerequisites](#prerequisites)
* [Installation](#installation)
* [Usage](#usage)
* [License](#license)

:pencil: About The Project


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

:computer: Technologies

This project was developed with the following technologies:

- [React](https://pt-br.reactjs.org/)
- [Typescript](https://www.typescriptlang.org/)
- [Tailwind CSS](https://tailwindcss.com/)
- [Prisma](https://www.prisma.io/)

:runner: Getting Started


To run the project locally follow these steps:

:warning: Prerequisites

- [NodeJs](https://nodejs.org/en/) Prefer to install the LTS version.
- [Yarn](https://yarnpkg.com/) Need to install latest version prior to 2.0 version.

:construction_worker: Installation


1. To clone the project, run this command:

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


2. Install dependencies:

```
yarn install
```

:metal: 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
```

:page_facing_up: License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.