https://github.com/openupm/openupm-next
OpenUPM next
https://github.com/openupm/openupm-next
hacktoberfest
Last synced: 5 months ago
JSON representation
OpenUPM next
- Host: GitHub
- URL: https://github.com/openupm/openupm-next
- Owner: openupm
- License: bsd-3-clause
- Created: 2023-06-11T17:59:59.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-11-18T20:14:22.000Z (8 months ago)
- Last Synced: 2025-11-18T21:12:26.563Z (8 months ago)
- Topics: hacktoberfest
- Language: TypeScript
- Homepage:
- Size: 9.41 MB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# OpenUPM Next
- [OpenUPM Next](#openupm-next)
- [Layout](#layout)
- [Install](#install)
- [Development](#development)
Codebase for OpenUPM website and services.
## Layout
`apps/`
| Package Name | Description |
| ------------ | --------------- |
| `docs` | OpenUPM website |
| `web` | API web server |
| `job` | cron job server |
`packages/` - ecosystem packages
| Package Name | Description |
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
| `vuepress-plugin-openupm` | Internal VuePress plugin for the OpenUPM website. |
| `@openupm/types` | TypeScript type definitions. |
| `@openupm/test` | Test arbitraries for Fast-check. |
| `@openupm/common` | Shared code for Node.js and VuePress. |
| `@openupm/server-common` | Shared code for Node.js server. |
| `@openupm/local-data` | Handles [local data](https://github.com/openupm/openupm/tree/master/data) such as package metadata YAML files, topics, backers... |
| `@openupm/ads` | ad backend |
| `pkg-template` | Package template for @openupm/apps |
## Install
Install volta to manage node version:
```
curl https://get.volta.sh | bash
```
Then install dependencies:
```
npm install
```
## Development
Build and test:
```
# Build
npm run build
# Test
npm run test
```
Run the docs website:
```
cd apps/docs
npm run docs:dev
```
Test the local web API server:
```
cd apps/web
npm run start
cd apps/docs
VITE_OPENUPM_API_SERVER_URL=http://localhost:3600 npm run docs:dev
```