https://github.com/ashblue/uvpm-server
A private Unity package manager server for Ultra Violet Package Manger (UVPM). The back-end server portion of the software.
https://github.com/ashblue/uvpm-server
package-manager server unity3d
Last synced: 11 months ago
JSON representation
A private Unity package manager server for Ultra Violet Package Manger (UVPM). The back-end server portion of the software.
- Host: GitHub
- URL: https://github.com/ashblue/uvpm-server
- Owner: ashblue
- License: agpl-3.0
- Created: 2017-12-31T03:38:09.000Z (about 8 years ago)
- Default Branch: develop
- Last Pushed: 2018-06-05T01:32:52.000Z (over 7 years ago)
- Last Synced: 2025-03-17T05:21:47.756Z (11 months ago)
- Topics: package-manager, server, unity3d
- Language: TypeScript
- Homepage:
- Size: 321 KB
- Stars: 7
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# uv-package-manager
[](https://travis-ci.org/ashblue/uvpm-server)
[](https://codecov.io/gh/ashblue/uvpm-server)
A package manager for Unity3D. The back-end server portion of the software. Meant to be paired with [UVPM CLI](https://github.com/ashblue/uvpm-cli) to interact with packages.
# Quickstart
Install [Docker](https://www.docker.com) if you haven't already. This is meant for
previewing the UVPM server and not developing on it.
```bash
docker-compose up -d
# Create a super user for yourself inside the Docker box
docker exec -it uvpm bash
npm run create-user
npm run user-role
# You can now login and publish packages via UVPM CLI
```
On your production server you will need about 2GB of memory total to run the package manager.
Most of this is for Elasticsearch to fuzzy search packages.
## Development
If you're looking to do development work and not just run the app. You'll need to do a
few extra steps.
* Go through the below section to start the databases
* When complete run `npm run start`
### IMPORTANT NOTE: Git commit and push pre hooks
Git **commit** runs the linter and build automatically.
For git **push** must have the dev Docker compose container running to
since tests are automatically run with pre hooks. If Docker is not running the
push hooks will hang due to slow server responses on tests.
### Running the database
Instead of running MongoDB and Elastic Search separately, you can run both with a simple
Docker command.
* Download and install [Docker](https://www.docker.com/)
* Spin up the database `docker-compose -f docker-compose.dev.yml up`
* Run `docker-compose -f docker-compose.dev.yml up -d` if you don't want terminal logging
* When done run `docker-compose -f docker-compose.dev.yml down` to properly shut down the database
#### Cleaning the database
You can also do a clean run of Docker without any data. Be warned though, this will delete ALL of your
database data for any Docker application (use with care).
```bash
docker system prune
docker volume prune
```
# Supported environmental variables
* NODE_ENV: For running Node in production mode `NODE_ENV=production`
* TEST: `true` or `false` to set the test mode
* DB_URL: Set the current database URL for MongoDB to connect to. For external database connections
* JWT_SECRET: Set your JWT secret key
# Commands
```bash
# If you are running a Docker server
# Turn on execute command mode in the docker box
docker exec -it uvpm bash
# If you haven't built out the project yet
# npm run build
```
## How to create a user
```bash
npm run create-user
```
## How to set user permissions
```bash
npm run user-role
```
## Change a password
```bash
npm run set-password
```
# Testing
Run all tests and automatically re-run all tests when a file changes.
```bash
npm run test
```
Run all tests once.
```bash
npm run test:single
```
Run a single test file with watch. Auto reloads when changing files.
```bash
npm run test:file -- src/app/app.spec.ts
```