royce
Extremely simple Axum + SolidJS starter for a fullstack web application.
File Explorer
Download Latest Version (.zip)- V1__create_users_table.sql
- middleware.rs
- mod.rs
- private.rs
- public.rs
- responses.rs
- backend.rs
- mod.rs
- sessions.rs
- mod.rs
- user.rs
- migration.rs
- mod.rs
- setup.rs
- errors.rs
- main.rs
- utils.rs
- Cargo.lock
- Cargo.toml
- favicon.ico
- Nav.tsx
- [...404].tsx
- index.tsx
- login.tsx
- private.tsx
- register.tsx
- helpers.tsx
- logging.tsx
- requests.tsx
- app.css
- app.tsx
- entry-client.tsx
- entry-server.tsx
- global.d.ts
- store.tsx
- app.config.ts
- package.json
- postcss.config.cjs
- README.md
- tailwind.config.cjs
- tsconfig.json
- .dockerignore
- .env
- .gitignore
- compose.yaml
- dev.env
- Dockerfile
- LICENSE
- README.md
# Installation Guide
1. Get the code
git clone https://github.com/J-Schoepplenberg/royce
Downloads the entire project code from GitHub to your computer.
cd royce
Moves into the project folder you just downloaded.
2. Docker
Easy RecommendedPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose up --build
Builds and starts all defined containers (server, database, etc.) at once, in the background.
docker run -d --name royce-postgres -e POSTGRES_USER=user -e POSTGRES_PASSWORD=password -e POSTGRES_DB=royce -p 5432:5432 -v pgdata:/var/lib/postgresql/data postgres:latest
Runs the built image as an actual container.
docker run -d --name royce-redis -p 6379:6379 redis:latest
Runs the built image as an actual container.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
Pulled directly from this repo's README.
3. Node.js
EasyPrerequisites
cd frontend
This project's files live in a subfolder, so move into it first.
npm install
Downloads and installs the libraries listed in package.json.
npm start
Starts the development/run server.
After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
4. Rust
MediumPrerequisites
- Git Needed to download the project code from GitHub.
- Rust (rustup) Installing via rustup also installs cargo.
cd backend
This project's files live in a subfolder, so move into it first.
cargo build --release
Compiles the Rust project.
cargo run
Builds and then immediately runs the program.
If cargo build finishes without errors, it worked. The executable is created under target/.
// repository documentation
Was this content helpful?
(0 ratings)