docs: update README files

[Aquitano]

Describe the feature

The current README lacks some important information that would be beneficial for users and contributors.

1. A more detailed description of the project: What is Nixi? What does it do? Who is it for?
2. Installation instructions: How can someone get Nixi up and running on their machine?
3. Usage instructions: Once installed, how does one use Nixi?
4. Contribution guidelines: If someone wants to contribute to Nixi, what steps should they follow?

Is your feature request related to a problem? Please describe

./.

Additional context

./.

[AlphaDecodeX]

I can work on this @Aquitano Kindly Kindly assign this to me

[Aquitano]

Hi @AlphaDecodeX, thank you for your interest in this issue. I appreciate your willingness to contribute. I'm assigning this issue to you. Please feel free to reach out if you have any questions or need any help. Looking forward to your pull request!

[AlphaDecodeX]

@Aquitano After running pnpm i and then pnpm run dev but getting errors

> turbo run dev --parallel

• Packages in scope: config, extension, server, tsconfig
• Running dev in 4 packages
• Remote caching disabled
server:dev: cache bypass, force executing 7936482a53e4f2fa
server:dev: 
server:dev: > server@0.0.0 dev /Users/lovepreetsingh/Desktop/Side/Nixi/apps/server
server:dev: > nest start --watch
server:dev: 
server:dev: [8:41:16 PM] Starting compilation in watch mode...
server:dev: 
server:dev: [8:41:17 PM] Found 0 errors. Watching for file changes.
server:dev: 
server:dev: 
server:dev: /Users/lovepreetsingh/Desktop/Side/Nixi/node_modules/.pnpm/supertokens-node@14.0.2/node_modules/supertokens-node/lib/build/recipe/thirdparty/providers/apple.js:69
server:dev:         throw new error_1.default({
server:dev:               ^
server:dev: Error: Cannot read properties of undefined (reading 'startsWith')
server:dev:     at Function.Apple (/Users/lovepreetsingh/Desktop/Side/Nixi/node_modules/.pnpm/supertokens-node@14.0.2/node_modules/supertokens-node/lib/build/recipe/thirdparty/providers/apple.js:69:15)
server:dev:     at Object.<anonymous> (/Users/lovepreetsingh/Desktop/Side/Nixi/apps/server/src/config.ts:45:31)
server:dev:     at Module._compile (node:internal/modules/cjs/loader:1246:14)
server:dev:     at Object.Module._extensions..js (node:internal/modules/cjs/loader:1300:10)
server:dev:     at Module.load (node:internal/modules/cjs/loader:1103:32)
server:dev:     at Function.Module._load (node:internal/modules/cjs/loader:942:12)
server:dev:     at Module.require (node:internal/modules/cjs/loader:1127:19)
server:dev:     at require (node:internal/modules/helpers:112:18)
server:dev:     at Object.<anonymous> (/Users/lovepreetsingh/Desktop/Side/Nixi/apps/server/src/auth/supertokens/supertokens.service.ts:3:1)
server:dev:     at Module._compile (node:internal/modules/cjs/loader:1246:14)```

[Aquitano]

Hi @AlphaDecodeX

Thanks for reaching out with your issue. It seems like the problem might be due to some environment variables not being set. Here's how you can fix this:

1. In the server folder, you'll find a file named example.env. Make a copy of this file in the same directory.
2. Rename the copied file to .env.
   (Alternatively, if you're on a Linux system, you can accomplish steps 1 and 2 by running the command cp example.env .env within the server folder.)
3. Open the .env file and fill in the values for any variables that haven't been set. These variables are marked with a *# at the beginning of each line. Please remember to remove the *# once you've set the value.

In the database setup, just input a password like:

DATABASE_URL="postgresql://api:PAS@localhost:5434/nest?schema=public"
DATABASE_PASSWORD=PAS

For local testing, you can use the OAuth IDs and secrets provided by Supertokens:

GOOGLE_CLIENT_ID=1060725074195-kmeum4crr01uirfl2op9kd5acmi9jutn.apps.googleusercontent.com
GOOGLE_CLIENT_SECRET=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

GITHUB_CLIENT_ID=467101b197249757c71f
GITHUB_CLIENT_SECRET=e97051221f4b6426e8fe8d51486396703012f5bd

APPLE_CLIENT_ID=4398792-io.supertokens.example.service
APPLE_KEY_ID=7M48Y4RYDL
APPLE_TEAM_ID=YWQCXGJRJL
APPLE_PRIVATE_KEY=-----BEGIN PRIVATE KEY-----\nMIGTAgEAMBMGByqGSM49AgEGCCqGSM49AwEHBHkwdwIBAQQgu8gXs+XYkqXD6Ala9Sf/iJXzhbwcoG5dMh1OonpdJUmgCgYIKoZIzj0DAQehRANCAASfrvlFbFCYqn3I2zeknYXLwtH30JuOKestDbSfZYxZNMqhF/OzdZFTV0zc5u5s3eN+oCWbnvl0hM+9IW0UlkdA\n-----END PRIVATE KEY-----

Once you've done this, try running pnpm i and pnpm run dev again. This should hopefully resolve the issue you're facing.

If you encounter any further problems or have any other questions, please don't hesitate to ask. I'm here to assist you!

Best, Aquitano / Thomas

[AlphaDecodeX]

@Aquitano Do i need to install Postgres or any other things in my local apart from Node, npm

[Aquitano]

@AlphaDecodeX There is a Docker Compose file in apps/server. It contains Postgres and the Supertokens Core—you have to start the two containers with docker compose up db supertokens in apps/server directory.

[AlphaDecodeX]

@Aquitano Thanks for letting me know. I am looking forward to make more contributions towards this project after this one

[Aquitano]

@AlphaDecodeX Any updates or questions? I am happy to help you.