https://github.com/ukrainian-freedom/ompua
Переклад документації open.mp (sa:mp, самп) українською. Офіційний сайт проєкту: https://open.mp/uk. Спершу комміти робляться на цьому репо, а пізніше єдиним паком робляться на blefnk/web репо, котре є форком openmultiplayer/web.
https://github.com/ukrainian-freedom/ompua
blefonix open-mp sa-mp samp san-andreas-multiplayer ukrainian
Last synced: 4 months ago
JSON representation
Переклад документації open.mp (sa:mp, самп) українською. Офіційний сайт проєкту: https://open.mp/uk. Спершу комміти робляться на цьому репо, а пізніше єдиним паком робляться на blefnk/web репо, котре є форком openmultiplayer/web.
- Host: GitHub
- URL: https://github.com/ukrainian-freedom/ompua
- Owner: ukrainian-freedom
- Created: 2024-09-29T13:44:36.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-09-29T13:48:22.000Z (8 months ago)
- Last Synced: 2024-10-01T07:04:14.670Z (8 months ago)
- Topics: blefonix, open-mp, sa-mp, samp, san-andreas-multiplayer, ukrainian
- Language: MDX
- Homepage: https://github.com/blefnk/web
- Size: 15.5 MB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
open.mp multiplayer game framework
A multiplayer mod for Grand Theft Auto: San Andreas that is fully backwards
compatible with San Andreas Multiplayer.
# open.mp Web Services
This monorepo contains the web services and documentation for open.mp and SA-MP.
## Overview
- `docs/` Wiki documentation for SA-MP and open.mp in Markdown format including translations.
- `frontend/` [Next.js](https://nextjs.org) app for the https://open.mp site.
- `prisma/` [Prisma](https://prisma.io/) database models for generating Go code and SQL migrations.
- `app/` Backend API for server listings, accounts, etc.
## Frontend Development
To work on the frontend, you mostly only need to focus on the `frontend/` directory. Run `npm` commands in there such as `npm run dev`. See the readme file in there for more details.
The only files that the frontend need that _are not_ in that directory are `docs/` which it uses to for the https://open.mp/docs pages. `.env` is not used for frontend development.
## Backend/Full Stack Development
When working on the backend, the root of the repository is where you need to be. The server application will assume it's being run from the root, _not_ from within `cmd/`.
To start the API server, use [Taskfile](https://taskfile.dev) and run `task`, the default task is to build and run the API server.
The frontend, by default, only uses the live API. To change this you must edit any URLs from `https://api.open.mp/...` to `http://localhost/...`.
You can run the following command to get a minimal development environment ready:
```
docker-compose -f .\docker-compose.dev.yml up -d
```
The `.dev.yml` Compose configuration contains services that aren't secure or production ready and suitable for local testing.
## Deployment
The frontend is deployed directly to [Vercel](https://vercel.com) from the `master` branch.
The backend is deployed to a server from the `master` branch using the `docker-compose.yml` file. You can simulate a production deployment by running `docker-compose up`.
### Uploading Assets
We host large static assets such as images and videos on an S3-compatible object storage. This runs at `assets.open.mp` and you can use the task `upload-assets` to upload all public assets from `frontend/public`.
The easiest way to do this is via the [Minio client](https://docs.min.io/docs/minio-client-quickstart-guide.html). Once installed, set up an alias called `omp`:
```
mc alias set omp https://assets.open.mp ACCESS_KEY SECRET_KEY
```
Replace the two keys with the real keys.
Then run the task:
```
task upload-assets
```