From c15d242a3d2930097a9420d0b581b9e1db15bcd1 Mon Sep 17 00:00:00 2001 From: Kakious Date: Thu, 8 Aug 2024 18:50:21 -0400 Subject: [PATCH] chore: fix readme --- README.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 371bc6c..c5e8700 100644 --- a/README.md +++ b/README.md @@ -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. -## Development +## Development (Still a WIP) 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 . -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`. +You will need pnpm installed globally. You can install it by running `npm install -g pnpm` in your terminal. + 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. @@ -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. -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 Name: WaterWolf Default Org Slug: waterwolf -The default user that is created is: +The default user that is created is: (NOT IMPLEMENTED YET) Username: admin Password: changeme