https://github.com/nightblade9/rapidweb
A "quick-start" web application template, written in .NET and Blazor.
https://github.com/nightblade9/rapidweb
blazor csharp csharp-code dotnet razor web website website-template
Last synced: 4 months ago
JSON representation
A "quick-start" web application template, written in .NET and Blazor.
- Host: GitHub
- URL: https://github.com/nightblade9/rapidweb
- Owner: nightblade9
- License: mit
- Created: 2023-12-11T00:47:43.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-10T05:12:15.000Z (5 months ago)
- Last Synced: 2025-03-28T10:16:44.451Z (4 months ago)
- Topics: blazor, csharp, csharp-code, dotnet, razor, web, website, website-template
- Language: C#
- Homepage:
- Size: 939 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# RapidWeb
RapidWeb is an opinionated, quick-start web application, intended as a base template website (just add business logic)!
Features:
- Lightning fast
- Registration
- Authentication (login)
- Docker container deployment
RapidWeb is highly performant: there are no web APIs to make local network calls to, and the database is embedded. (You can swap out a local non-embedded database, or scale up by connecting multiple instances to the same DB.)
The tech stack:
- Blazor and C# on the front-end
- SQLite on the back-end, with DB migrations
- Secure password hashing via BCrypt
# Developer Environment Setup
Download the following:
- .NET 8 SDK
- Visual Studio Code
Open the source project and press F5 in VS Code; it should run and show the dashboard.
Browse to `/admin/HealthCheck` and verify that the database connection check shows `Successful`.
Note that we're currently using SQLite to simplify deployment.
# Architecture
History repeats, and so do web architectures. We're back to HTML pages with code-behind. For example, `Register.cshtml` contains the registration form, while `Register.cshtml.cs` contains the code-behind.
# Running the App via Docker
To run the application via Docker:
- From a shell, `cd` into `scripts` and run `python .\build_docker_image.py`
- When the process drops you in the docker container, type `exit`
- Run `docker compose up` to start the app and map port 8080 from the container to port 80 on the host (your PC)
- Open a new browser window and browse to `localhost:80`
Note that we're using SQLite for data:
- The database isn't high-performance, but it works, even with migrations
- The database exists as a file on disk (`prod.db` in the docker container under `./WebApp.Web`)
- The DB file seems to persist even after building a new version of the same image
To import the locally-built image into prod:
- From `scripts` run `python export_docker_image.py`
- On the prod machine, run `docker load -i latest_image.tar`
- Run the image in a container with the script `deploy.py` from `scripts`
Open a browser and browse to `http://localhost:80`. Tada!
Note that we currently use SQLite, to simplify deployment. The DB file persists even when you update the image, as long as you run it in the same container.
# License & Legal Disclaimer
This software is provided *"as is"* without any warranties. By using this software, you agree to the terms outlined in [LICENSE](./LICENSE).