Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhance documentation #2

Merged
merged 3 commits into from
Jun 10, 2024
Merged

Enhance documentation #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8987f11
Add a few more steps on the documentation and a nvmrc file to much th…
kosmotrade Jun 7, 2024
9f2e960
Add admin wallet explanation
kosmotrade Jun 7, 2024
b8b0a33
chore: update README
beeman Jun 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .nvmrc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
v20.10.0
21 changes: 19 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,26 @@

### Prerequisites

- Node v18 or higher
- Node v20 or higher
- PNPM
- Docker

> [!TIP]
> If you don't have PNPM installed, you can install it using `corepack`:
>
> ```sh
> corepack enable
> corepack prepare pnpm@latest --activate
> ```

### Installation

Clone the repo and install dependencies:

```shell
git clone git@github.com:pubkeyapp/deanslist-platform.git
cd deanslist-platform
pnpm
pnpm install
```

### Automatic setup
Expand All @@ -34,6 +42,15 @@ Copy the `.env.example` file to `.env` and fill in the missing values.
cp .env.example .env
```

Create a `JWT_SECRET` and a `SESSION_SECRET`, using the command below, and update them in `.env` file:
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or we could add some hard coded ones on the .env.example

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's good practice to teach people to generate it. If they want to be lazy and insecure they will probably set it to secret or foo anyway 😁


```shell
openssl rand -hex 32
```

Get your Solana wallet and update the `AUTH_SOLANA_ADMIN_IDS` in `.env` file.
Once you start the app, if you connect with the same wallet id you will have admin rights.

### Starting the services

You will need to start the database before starting the backend.
Expand Down
Loading