docs: update readme
This commit is contained in:
+1
-23
@@ -5,27 +5,5 @@
|
||||
|
||||
NEXT_PUBLIC_APP_NAME=Crosslog
|
||||
NEXT_PUBLIC_OUR_DOMAIN=localhost:3000
|
||||
NEXT_PUBLIC_R2_URL=https://r2.egoist.workers.dev
|
||||
NEXT_PUBLIC_DISCORD_LINK="https://discord.gg/ucBPN7brXf"
|
||||
NEXT_PUBLIC_DISCORD_LINK="https://discord.gg/9XscSqJEq4"
|
||||
NEXT_PUBLIC_GITHUB_LINK="https://github.com/Crossbell-Box/Crosslog"
|
||||
|
||||
#############################################################
|
||||
#### Followings are runtime secrets set via Fly CLI
|
||||
#############################################################
|
||||
|
||||
DATABASE_URL='postgres://postgres:pass@localhost:5432/proselog?schema=public'
|
||||
|
||||
AUTH_COOKIE_NAME=proselog.token
|
||||
|
||||
# openssl rand -base64 32
|
||||
ENCRYPT_SECRET=uIeqyCW1E5PbK2ztsc+UXcPwsZ0L/Z4k08ArOSaKpHHFViRbdnFJcQ==
|
||||
|
||||
MAILGUN_APIKEY=
|
||||
# use separate domain for transcantional email / newsletter email
|
||||
MAILGUN_DOMAIN_TRANSANCTION=
|
||||
MAILGUN_DOMAIN_NEWSLETTER=
|
||||
|
||||
# access token for our umami instance
|
||||
UMAMI_TOKEN=
|
||||
|
||||
WEB3_STORAGE_API_TOKEN=
|
||||
|
||||
@@ -1,20 +1,15 @@
|
||||
# Crosslog
|
||||
|
||||
> On-Chain Content Creating for Absolutely Everyone
|
||||
|
||||
Meet Crosslog, the on-chain and open-source blogging platform for everyone. Permanently stored on-chain and signed by you.
|
||||
|
||||
This project is developed based on [proselog](https://github.com/proselog/proselog)
|
||||
|
||||
## Development
|
||||
|
||||
Follow the steps to run it locally.
|
||||
|
||||
1. Copy `.env.example` to `.env`
|
||||
2. Run `postgres` locally, the easiest way on mac is `brew install postgresql`, you can also use docker
|
||||
|
||||
```bash
|
||||
docker run -d \
|
||||
--name mypostgres \
|
||||
-e POSTGRES_PASSWORD=pass \
|
||||
-e PGDATA=/var/lib/postgresql/data/pgdata \
|
||||
-v mypostgres_data:/var/lib/postgresql/data \
|
||||
-p 5432:5432 \
|
||||
postgres
|
||||
```
|
||||
|
||||
3. Install dependencies: `pnpm i`
|
||||
4. Initialize the database by running `pnpm prisma db push`
|
||||
5. Start dev server: `pnpm dev`
|
||||
2. Install dependencies: `pnpm i`
|
||||
3. Start dev server: `pnpm dev`
|
||||
|
||||
Reference in New Issue
Block a user