mirror of
https://github.com/status-im/status-web.git
synced 2026-08-30 22:01:15 +00:00
Jules
1100022820
* chore(README): add git submodule init step & contributing instructions * chore(apps/api): add README * chore(apps/hub): add README * chore(apps/status.app): update README & add comment regarding vaults disabling * chore: add changeset * chore(README): remove useless git commands * chore(README): fix broken note * chore(README): fix broken code in note
39 lines
799 B
Markdown
39 lines
799 B
Markdown
# Status API
|
|
|
|
This is the repository for the Status API.
|
|
|
|
## Prerequisites
|
|
|
|
Required:
|
|
|
|
- **[Node.js](https://nodejs.org/)** v22.x
|
|
- **[pnpm](https://pnpm.io)** v9.12.x
|
|
|
|
## Getting Started
|
|
Go to the project directory:
|
|
|
|
```bash
|
|
cd apps/api
|
|
```
|
|
|
|
Install dependencies:
|
|
|
|
```bash
|
|
pnpm install
|
|
```
|
|
|
|
Pull environment variables:
|
|
|
|
```bash
|
|
vercel env pull .env.local
|
|
```
|
|
> [!NOTE]
|
|
> This project is deployed on Vercel at [https://vercel.com/status-im-web/status-api](https://vercel.com/status-im-web/status-api).
|
|
> You can also get the environment variables manually from [there](https://vercel.com/status-im-web/status-api/settings/environment-variables). However this is recommended to pull envs through the Vercel CLI as there are a lot of them.
|
|
|
|
|
|
Start the development server:
|
|
|
|
```bash
|
|
pnpm dev
|
|
``` |