https://github.com/w2inc/nxtapp
Open source peer to peer education monorepo
https://github.com/w2inc/nxtapp
Last synced: 4 months ago
JSON representation
Open source peer to peer education monorepo
- Host: GitHub
- URL: https://github.com/w2inc/nxtapp
- Owner: W2Inc
- License: other
- Created: 2024-06-20T11:20:56.000Z (12 months ago)
- Default Branch: master
- Last Pushed: 2025-02-17T23:21:45.000Z (4 months ago)
- Last Synced: 2025-02-21T14:50:14.577Z (4 months ago)
- Language: C#
- Homepage:
- Size: 12.7 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# NXT Application
A modern, self-hostable, and fully open-source education platform designed to change how we approach learning. NXT aims to break free from traditional educational constraints by offering a flexible, peer-driven learning environment that emphasizes practical experience and collaboration.
> **Note**: The application is still a work in progress and not complete nor production ready.
## 🚀 Project Structure
```ts
NXTApp/
├── backend/ # .NET Core backend
│ ├── NXTBackend.API # Controllers, Ratelimiter, Middleware, ...
│ ├── NXTBackend.API.Core # Core business logic
│ ├── NXTBackend.API.Domain # Models for the database
│ ├── NXTBackend.API.Infrastructure # Database setup, migrations, contexts, ...
│ └── NXTBackend.API.Model # Request and response models (DO's, DTO's, ...)
└── frontend/ # SvelteKit frontend
├── src/ # Source code
└── static/ # Static assets
```
# 🛠️ Technology Stack
## Backend
- .NET 9.0
- Entity Framework Core
- OpenAPI/Swagger
- Keycloak Authentication
## Frontend
- SvelteKit
- Bun
- TypeScript
- OpenAPI Client
- TailwindCSS
# 🚦 Getting Started
## Prerequisites
- .NET 9.0 SDK
- Bun Runtime
- PostgreSQL @ 16.0
- Minio (for self-hosted S3 storage)
- Keycloak @ 26.0.0
## Environment Variables
```env
# Keycloak Configuration
KC_CLIENT_ID="intra"
KC_CLIENT_SECRET="..."
KC_ISSUER="..."
KC_COOKIE_NAME="kc.session"
# Application
APP_NAME="App"
# S3 Storage (Minio)
S3_BUCKET="..."
S3_ACCESS_KEY_ID="..."
S3_SECRET_ACCESS_KEY="..."
S3_ENDPOINT="..."
```
## Backend
```sh
cd /Users/wizard/Developer/NXTApp/backend
dotnet restore
dotnet build
dotnet run --project "NXTBackend.API" --launch-profile "http"
```
### Migrations
```sh
cd /Users/wizard/Developer/NXTApp/backend
dotnet ef migrations add --project "NXTBackend.API.Infrastructure" -s "NXTBackend.API"
dotnet ef database update --project "NXTBackend.API.Infrastructure" -s "NXTBackend.API"
```
## Frontend
```sh
cd /Users/wizard/Developer/NXTApp/frontend
bun install
bun --bun run dev
```
# 🚀 Deployment
The recommended deployment method is via Coolify. Coolify is an open source self hostable 'vercel' essentially that gives you a several templates to spin up services.
This provides:
- Automatic deployments from Git
- Environment variable management
- Container orchestration
- SSL certificate management
- Backups
- ...
## Minio Setup
- Deploy Minio instance
- Create bucket and access credentials
- Configure S3 environment variables
# Coolify Deployment Notes
- In some cases the docker containers will be unable to connect properly. This is due to docker / docker compose and how things work with the DNS resolving etc I believe (not sure if that was the cause but it has to do with docker network)
1. To fix 99% of the issue go into the coolify page and extract the service id from the url
2. SSH into the VPS
3. `sudo docker network inspect eddddddd8kokwokcwkokgoc4`
4. Extract the container ipv4 address
5. `sudo ufw allow from 10.0.3.3/24`
6. `sudo ufw status & sudo ufw reload`
7. PROFIT!
## What to implement
Master deployment script that you can setup NXTApp with a single curl command:
- Ask for the type of setup (single deploy aka all in one server (BAD IDEA!!!))
- Single deploy: Nice for quick testing and checking out, installs coolify, sets up the services all on the current machine (bad idea btw)
- Multi deploy: For the relevant services what their IP / where to connect to so that we can create those servers into coolify and it all just works.