https://github.com/alevidals/petrol-stations
https://github.com/alevidals/petrol-stations
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/alevidals/petrol-stations
- Owner: alevidals
- Created: 2024-04-10T09:17:37.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-11T12:37:23.000Z (10 months ago)
- Last Synced: 2025-01-22T03:14:05.738Z (4 months ago)
- Language: TypeScript
- Homepage: https://petrol-stations.vercel.app/
- Size: 205 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Petrol Stations
Gazason is a web application that allows you to calculate the cheapest petrol station prices for a given number of liters.
Table of contents
- [Petrol Stations](#petrol-stations)
- [To start](#to-start)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Back](#back)
- [Front](#front)
- [Tests](#tests)
## To start
### Prerequisites
- Node > 20 version. You can use [NVM](https://github.com/nvm-sh/nvm?tab=readme-ov-file#installing-and-updating) to setup a node version manager
- Package manager
- PNPM
```sh
npm install -g pnpm
```
- NPM
```sh
npm install -g npm@latest
```
- YARN
```sh
npm install -g yarn
```
### Installation
At first clone the repository
```sh
git clone https://github.com/alevidals/petrol-stations
```
#### Back
1. Move to the backend directory
```sh
cd back
```
2. Install dependencies (You can use `npm` or `yarn` instead of `pnpm` if you like)
```sh
pnpm install
```
3. Execute the project (You can use `npm` or `yarn` instead of `pnpm` if you like)
```sh
pnpm run dev
```
#### Front
1. Move to the frontend directory
```sh
cd front
```
2. Install dependencies (You can use `npm` or `yarn` instead of `pnpm` if you like)
```sh
pnpm install
```
3. Execute the project (You can use `npm` or `yarn` instead of `pnpm` if you like)
```sh
pnpm run dev
```
### Tests
To execute tests on the frontend execute the following script (You can use `npm` or `yarn` instead of `pnpm` if you like)
```sh
pnpm test:unit
```