kakious/waterwolf-auth
2
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

chore: fix readme

Browse source
This commit is contained in:
Kakious 2024-08-08 18:50:21 -04:00
parent 62bb9531c0
commit c15d242a3d
1 changed files with 5 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -4,13 +4,12 @@
This is the identity service for the Waterwolf project. It is a NestJS application that provides an API for managing users and authentication. This is the identity service for the Waterwolf project. It is a NestJS application that provides an API for managing users and authentication.
## Development ## Development (Still a WIP)
To get started with development, first clone the repository. To get started with development, first clone the repository.
Create a GitHub classic PAT with permission to read repos and packages in order to be able to install the private furality npm packages . You will need pnpm installed globally. You can install it by running `npm install -g pnpm` in your terminal.
https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-personal-access-token-classic
Create the token and put it in a file in the root of the repository named `.github_token`.
Then install vscode which supports devcontainers and open the repository in vscode as a devcontainer. Then install vscode which supports devcontainers and open the repository in vscode as a devcontainer.
This will set up all the necessary supporting services needed to run, test, and debug this service. This will set up all the necessary supporting services needed to run, test, and debug this service.
@ -27,12 +26,12 @@ http://localhost:{PORT}/v1/api/ to ensure it has started correctly
Currently the documentation is a work in progress. The documentation is generated using the OpenAPI specification and can be found at the `/v1/api` path of the service. Currently the documentation is a work in progress. The documentation is generated using the OpenAPI specification and can be found at the `/v1/api` path of the service.
The current defaults that are generated at initialization are: The current defaults that are generated at initialization are: (NOT IMPLEMENTED YET)
Default Org Id: 1 Default Org Id: 1
Default Org Name: WaterWolf Default Org Name: WaterWolf
Default Org Slug: waterwolf Default Org Slug: waterwolf
The default user that is created is: The default user that is created is: (NOT IMPLEMENTED YET)
Username: admin Username: admin
Password: changeme Password: changeme