Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chaotic-cx/chaotic-next
Website and backend-related projects of Chaotic-AUR 🚀
https://github.com/chaotic-cx/chaotic-next
angular chaotic-aur nestjs nx typescript
Last synced: 5 days ago
JSON representation
Website and backend-related projects of Chaotic-AUR 🚀
- Host: GitHub
- URL: https://github.com/chaotic-cx/chaotic-next
- Owner: chaotic-cx
- License: gpl-3.0
- Created: 2024-06-02T17:51:35.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-12-30T21:43:46.000Z (5 days ago)
- Last Synced: 2024-12-30T22:29:25.670Z (5 days ago)
- Topics: angular, chaotic-aur, nestjs, nx, typescript
- Language: TypeScript
- Homepage: https://aur.chaotic.cx
- Size: 3.22 MB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-starred - chaotic-cx/chaotic-next - Website and backend-related projects of Chaotic-AUR 🚀 (TypeScript)
- awesome-starred - chaotic-cx/chaotic-next - Website and backend-related projects of Chaotic-AUR 🚀 (TypeScript)
README
# Chaotic-AUR Next
Monorepo for all Java-/Typescript projects of Chaotic-AUR. Includes:
- Part of repository management (.so lib bumps, up-to-date in-depth package data, etc..)
- Router stats
- Package, Router, Metrics API
- Extracting messages from a Telegram news channel to display on the website
- Chaotic-AURs website
- Smaller helper functions / API
## Building
To build the project, run the following command:
```bash
pnpm build
```
To run it locally for development purposes, run the following command:
```bash
pnpm start:home
pnpm start:be-nx
```
## Running a local CORS-enabled API proxy
To run a local CORS-enabled API proxy, change the following constants in the `types.ts` file of the shared libs to the
following values:
```typescript
export const CAUR_BACKEND_URL = 'http://localhost:8010/proxy/backend';
export const CAUR_API_URL = 'http://localhost:8010/proxy/api';
```
and run the following command afterward:
```bash
pnpm proxy:api
pnpm proxy:be
```
This will allow using the production API without CORS issues.
## Tech Stack
- Angular
- NestJs (Fastify, Passport, TypeORM, Swagger)
- Nx (Monorepo management)
- Postgresql
- Redis
- TailwindCSS
- Telegram API
- TypeORM
- Typescript
## Backend
### Required environment variables
- AUTH0_AUDIENCE: Auth0 audience to target
- AUTH0_CLIENT_ID: Auth0 client id
- AUTH0_CLIENT_SECRET: Auth0 client secret
- AUTH0_DOMAIN: Auth0 domain
- CAUR_DEPLOY_LOG_ID: Telegram chat id for deploy logs
- CAUR_JWT_SECRET: JWT secret for the backend
- CAUR_NEWS_ID: Telegram chat id for news
- CAUR_TRUST_PROXY: IP address of the proxy, if any
- CAUR_USERS: JSON object with user ids and roles
- NODE_ENV: "production" / any other for dev (will enable TypeORM sync mode)
- PG_DATABASE: Postgres database to use
- PG_HOST: Host name of the Postgres database
- PG_PASSWORD: Postgres password
- PG_USER: Postgres user
- REDIS_PASSWORD: Redis password to connect with the Chaotic Manager (Moleculer microservice)
- REDIS_SSH_HOST: Host of the Redis server, used for SSH port forwarding the Redis instance
- REDIS_SSH_USER: User to use for SSH port forwarding the Redis instance
- TELEGRAM_API_HASH: Telegram API hash
- TELEGRAM_API_ID: Telegram API id
- TELEGRAM_DB_ENCRYPTION_KEY: Encryption key for the Telegram database
## Database structure (as of November 2024)
## Integrate with editors
Enhance your Nx experience by installing [Nx Console](https://nx.dev/nx-console) for your favorite editor. Nx Console
provides an interactive UI to view your projects, run tasks, generate code, and more! Available for VSCode, IntelliJ and
comes with a LSP for Vim users.
## Nx plugins and code generators
Add Nx plugins to leverage their code generators and automated, inferred tasks.
```
# Add plugin
pnpm exec nx add @nx/react
# Use code generator
pnpm exec nx generate @nx/react:app demo
# Run development server
pnpm exec nx serve demo
# View project details
pnpm exec nx show project demo --web
```
Run `pnpm exec nx list` to get a list of available plugins and whether they have generators. Then run
`pnpm exec nx list ` to see what generators are available.
Learn more about [code generators](https://nx.dev/features/generate-code) and
[inferred tasks](https://nx.dev/concepts/inferred-tasks) in the docs.
## Running tasks
To execute tasks with Nx use the following syntax:
```
pnpm exec nx <...options>
```
You can also run multiple targets:
```
pnpm exec nx run-many -t
```
..or add `-p` to filter specific projects
```
pnpm exec nx run-many -t -p
```
Targets can be defined in the `package.json` or `projects.json`. Learn more
[in the docs](https://nx.dev/features/run-tasks).