https://github.com/ldgit/authorization-server

https://github.com/ldgit/authorization-server

Last synced: 12 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/ldgit/authorization-server
• Owner: ldgit
• License: agpl-3.0
• Created: 2024-07-09T20:42:51.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-10-01T16:03:23.000Z (about 1 month ago)
• Last Synced: 2024-10-05T08:05:30.301Z (about 1 month ago)
• Language: TypeScript
• Size: 528 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Authorization Server

[![build](https://github.com/ldgit/authorization-server/actions/workflows/build.yml/badge.svg)](https://github.com/ldgit/authorization-server/actions/workflows/build.yml)

### 🚧🚨 Unfinished WIP 🚨🚧

OAuth 2.0 authorization server implementation. Follows specification defined in:

- [IETF RFC 6749 The OAuth 2.0 Authorization Framework](https://datatracker.ietf.org/doc/html/rfc6749.html) 

- [IETF RFC 6750 The OAuth 2.0 Authorization Framework: Bearer Token Usage](https://datatracker.ietf.org/doc/html/rfc6750.html)

## Local Development

### First time setup

1. Create the `.env` file: `cp .dev.env .env`.

2. Install npm packages: `npm ci`.

3. `npx playwright install --with-deps` to install Playwright browsers for e2e testing.

### Starting the server 

1. Start up the database docker container: `docker-compose up -d`.

2. Set up the dev database: `npm run dev-db`.

3. Start the local server: `npm run dev`.

4. If working on css styles run `npm run styles -- --watch` separately.

5. Access in browser on `http://127.0.0.1:3000/`.

### Testing

To run unit and integration tests: `npm t`

To run end to end tests:

1. ***Optional*** `npm run dev` to start up the dev server. Playwright will do this automatically if the server is not running, but this is useful if you wish to see server errors in the console.

2. `npm run e2e` to run the tests.

## Tech used

- Fastify web framework

- PostgreSQL for database

- ejs for templating

- Tailwind for styles

- Vitest for unit and integration testing

- Playwright for e2e testing

- biome.js for linting and enforcing code style