Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kacperwyczawski/sigma-cars
🚘 Web app for renting cars. Built with ASP.NET Core and Vue/Nuxt, on Docker. Extremely easy to run locally via Docker compose.
https://github.com/kacperwyczawski/sigma-cars
api asp-net-core csharp docker docker-compose docker-hub dotnet github-actions javascript nginx nuxt open-api rest-api typescript vue
Last synced: about 1 month ago
JSON representation
🚘 Web app for renting cars. Built with ASP.NET Core and Vue/Nuxt, on Docker. Extremely easy to run locally via Docker compose.
- Host: GitHub
- URL: https://github.com/kacperwyczawski/sigma-cars
- Owner: kacperwyczawski
- License: agpl-3.0
- Created: 2023-04-02T14:33:17.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-08-20T08:55:10.000Z (over 1 year ago)
- Last Synced: 2024-10-01T00:03:50.022Z (about 2 months ago)
- Topics: api, asp-net-core, csharp, docker, docker-compose, docker-hub, dotnet, github-actions, javascript, nginx, nuxt, open-api, rest-api, typescript, vue
- Language: C#
- Homepage:
- Size: 8.85 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Sigma Cars
> **Note**
>
> Application is in beta.
## 📝 Description
Sigma Cars is a car rental application. This is a learning
project that was created to practice and demonstrate the development of a full stack web application. Users can search
for cars by location, price, and availability, and make reservations for the selected car.
- Sigma Cars is containerized using **Docker**, providing easy deployments and scalability.
- The backend is developed using **ASP.NET Core**, a high-performance framework, and utilizes a **PostgreSQL** database for efficient data storage and retrieval.
- The website is built using **Nuxt** and **Vue**, resulting in an interactive and visually appealing user interface. It is developed with a focus on type-safety by using **TypeScript**
- Project utilizes an **Nginx** proxy server, which acts as a reverse proxy, handling incoming requests and forwarding them to the appropriate services.
- This repository leverages **GitHub Actions** to automate the **CI/CD** process. This ensures that up-to-date images are pushed to **Docker Hub**, making it easy to deploy the latest version of the project.
- Users can choose to access the system via the **REST API** documented by **OpenAPI** schema, allowing programmatic interactions, or use the website for a user-friendly graphical interface.
## 🚀 How to run
1. Install and set up [Docker](https://www.docker.com/) on your machine.
2. Download [this](docker-compose.yml) file from repository. In PowerShell you can use: `Invoke-WebRequest https://raw.githubusercontent.com/kacperwyczawski/sigma-cars/main/docker-compose.yml -OutFile docker-compose.yml`.
3. Open Docker Desktop, ensuring that it is properly installed and running.
4. In your terminal or command prompt, navigate to the directory where you downloaded the docker-compose.yml file.
5. Run `docker compose up` to start the project.
## ⭐ How to use
- After running the application, open [`http://localhost`](http://localhost) in your preferred web browser.
- There is default admin account with email: `[email protected]` and password: `admin`.
#### 💭 Optional
- You can access OpenAPI schema at [`http://localhost/api/schema/v1`](http://localhost/api/schema/v1) (can be imported into Postman).
- Base path for all REST API endpoints is `http://localhost/api`.
## ⚒️ How to develop
First you need to clone this repository. After making changes, you can run the application with `docker compose up --build`.
If you want to use hot reload for frontend:
1. `cd SigmaCars/Frontend`.
2. `npm run dev`.
3. `docker compose up -f ../docker-compose.dev.frontend.yml`.
4. Website is now available at [`http://localhost`](http://localhost).
Details for Linux users:
There may be some problems with proxy_pass from nginx to host machine.
This stackoverflow answer may help: https://stackoverflow.com/questions/24319662/from-inside-of-a-docker-container-how-do-i-connect-to-the-localhost-of-the-mach/43541681#43541681
## 🔗 Application schema
```mermaid
flowchart TD
user([End user]) --- nginx{{Nginx reverse proxy}}
nginx --- backend(ASP.NET Core HTTP API)
backend --- database[(Postgres database)]
nginx --- frontend(Vue + Nuxt website)
```
## 🗃️ Simplified database schema
```mermaid
erDiagram
CarType ||--o{ Car : x
Department ||--o{ Car : x
Car ||--o{ Rental : x
User ||--o{ Rental : x
```
## 📫 Feedback
I hope you find Sigma Cars project helpful! If you encounter any issues or have any feedback, please don't hesitate to
contact me via github issues.