Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/toverux/halloffameserver
Server for the toverux/HallOfFame Cities: Skylines II mod
https://github.com/toverux/halloffameserver
cities-skylines cities-skylines-community cities-skylines-game-mod
Last synced: 1 day ago
JSON representation
Server for the toverux/HallOfFame Cities: Skylines II mod
- Host: GitHub
- URL: https://github.com/toverux/halloffameserver
- Owner: toverux
- License: agpl-3.0
- Created: 2024-06-09T10:53:22.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-10-18T12:11:05.000Z (27 days ago)
- Last Synced: 2024-10-18T21:39:31.337Z (27 days ago)
- Topics: cities-skylines, cities-skylines-community, cities-skylines-game-mod
- Language: TypeScript
- Homepage:
- Size: 2.64 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 
Hall of Fame Server
[](https://discord.gg/SsshDVq2Zj)
[](https://mods.paradoxplaza.com/mods/90641/Windows)
[](https://crowdin.com/project/halloffame-cs2)
Server part of the [Hall of Fame](https://github.com/toverux/HallOfFame) mod for
Cities: Skylines II.
This is a [Nest.js](https://nestjs.com/) project with an
[Angular](https://angular.dev) w/SSR frontend and
[Prisma](https://www.prisma.io) as a MongoDB ORM.
Featuring a simple REST-like HTTP API for uploading photos from the mod and
retrieving them.
## Features & Roadmap
Find our user feedback, feature request and roadmap board here:
[feedback.halloffame.cs2.mtq.io](https://feedback.halloffame.cs2.mtq.io).
## Development
### Installation
1. Install [Bun](https://bun.sh).
2. (Recommended) Install [Volta](https://volta.sh) for per-project Node.js
version management, or use Node >= 22. Node is still needed to run the
bundlers, while Bun is used for package management and the server runtime.
3. Run `bun i` to install dependencies.
4. You may `bun run build` to test that the project builds and everything is in
order.
5. Install
[MongoDB](https://www.mongodb.com/docs/manual/administration/install-community)
([more direct download links here](https://www.mongodb.com/try/download/community-edition)),
mongosh, and set up a replica set, here's an example, but it varies according
to your setup and preferences:
6. Set this in your configuration file (Linux: `/etc/mongod.conf`,
Windows: `C:\Program Files\MongoDB\Server\7.0\bin\mongod.cfg`):
```yml
replication:
replSetName: rs0
```
7. Restart MongoDB (`sudo systemctl restart mongod`, Windows: open "Services",
search for "MongoDB Server", right-click it and choose Restart).
8. Connecting to the database using `mongosh`, run `rs.initiate()` to create
a default rs0 replica set, check there's no error.
9. Run `bun prisma db push` to create the database, collections and indexes.
10. Done! Test that the server is working with `bun run:server:watch`.
To set up a replica set, you can also follow
[this guide](https://www.mongodb.com/docs/manual/tutorial/convert-standalone-to-replica-set/).
### Development Workflow
TBD
### Generating Database Schema
Database schema is generated from the Prisma schema file in
`prisma/schema.prisma`.
You might have to reconfigure the default development connection string if it
differs from the default in `.env`.
If it does differ, as `.env` is a defaults files that is versioned, do not
change it, instead override locally in `.env.local`.
- Update database schema from Prisma schema: `bun prisma db push`.
As the database is MongoDB which is schema-less, this essentially just creates
the collections (and the database if it does not exist), and indexes.
- Update Prisma Client definitions after schema change:
`bun prisma generate`.
Note that this is also done by `bun prisma db push`.
### Dump & Restore Database
Example for production to local database:
```shell
mongodump --uri "mongodb://user:pass@server:port/halloffame?replicaSet=rs0&directConnection=true" --gzip --archive=halloffame.mongoarchive
mongorestore --uri "mongodb://localhost/halloffame?replicaSet=rs0" --gzip --archive=halloffame.mongoarchive --nsInclude='default.*' --nsFrom='default.*' --nsTo='halloffame.*' --drop
bun prisma db push
```
### Updating Dependencies & Toolchain
- To update Bun: `bun upgrade`, and update `package.json#packageManager`.
- To update Node: `volta install node@latest`, and update
`package.json#engines.node`.
- To update npm dependencies: `bun pm:update`.
## Code Style
### TypeScript
TypeScript code is formatted and linted by [Biome](https://biomejs.dev).
Run `bun run check` to check for linting errors, format files and autofix simple
issues.
You can also use Biome directly with `bun biome`.
The formatter and linter should run as a pre-commit hook if you have it
installed, which should be done automatically when running `bun i` (otherwise,
run `bun lefthook install`).
I'd suggest to use a Biome plugin for your editor to ease development.
If a rule seems out of place for this project, you can either
disable/reconfigure it in the `biome.json` file or disable it with an annotation
comment, but these should be justified and concerted.
### Commit messages
Commits must follow the
[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0)
specification and more specifically the Angular one.
Scope can be one or more of the following:
- `server`: for non-specific changes in the server;
- `cli`: for changes in the CLI application;
- `admin`: for changes in the backoffice admin interface;
- `api`: for changes in the server HTTP API;
- `imgproc`: for changes in image processing;
- `database`: for changes in the database schema or related systems;
- `i18n`: for changes in translations and translations system;
- `deps`: for changes in dependencies (updates, additions, removals);
- Propose new scopes if needed!