Add Algolia Search + other quick improvements to docs (#198)
This commit is contained in:
@ -17,6 +17,6 @@ Run tests: `make front-test`
|
||||
Run coverage: `make front-coverage`
|
||||
Run storybook: `make front-storybook`
|
||||
|
||||
## Note
|
||||
|
||||
If you are using Docker install, make sure to ssh in the docker container during development to execute commands. You can also use `Makefile` to help you
|
||||
## Running commands
|
||||
If you are using Docker install, make sure to ssh in the docker container during development to execute commands.
|
||||
You can use `Makefile` to help you do this: `make sh` will open a CLI in the docker container and commands such as `make front-test` have been setup to be executed in the container.
|
||||
@ -1,6 +1,7 @@
|
||||
# Documentation
|
||||
|
||||
The stack is composed of 3 different layers:
|
||||
|
||||
# Stack Overview
|
||||
|
||||
import ThemedImage from '@theme/ThemedImage';
|
||||
|
||||
@ -12,3 +13,13 @@ import ThemedImage from '@theme/ThemedImage';
|
||||
}}
|
||||
/>
|
||||
|
||||
|
||||
# Quick Install
|
||||
|
||||
```
|
||||
npx twenty-cli
|
||||
```
|
||||
|
||||
# Questions, reports
|
||||
|
||||
Please open an issue or a discussion on the [GitHub repository](https://github.com/twenyhq/twenty).
|
||||
|
||||
@ -12,6 +12,7 @@ sidebar_custom_props:
|
||||
We built a CLI to guide you through the different options.
|
||||
|
||||
If you prefer to have more control and do things manually, go through the Docker section below.
|
||||
|
||||
Otherwise run the following command to get started:
|
||||
```
|
||||
npx twenty-cli
|
||||
@ -45,7 +46,12 @@ cd infra/dev
|
||||
make build
|
||||
```
|
||||
|
||||
### 5. Start
|
||||
### 5. Auth setup
|
||||
|
||||
Right now the only way to authenticate yourself is to setup Google Sign-in in `server/.env`
|
||||
We will add an easier option soon.
|
||||
|
||||
### 6. Start
|
||||
|
||||
Always in the `infra/dev` folder:
|
||||
```
|
||||
@ -59,7 +65,7 @@ Once this is completed you should have:
|
||||
- postgres: available on http://localhost:5432 that should contain `twenty` database
|
||||
|
||||
|
||||
## 6. Development
|
||||
### 6. Development
|
||||
|
||||
Documented [here](../development/workflows.mdx)
|
||||
|
||||
@ -75,18 +81,36 @@ You also need to bring your own Postgres database.
|
||||
`git clone git@github.com:twentyhq/twenty.git`
|
||||
|
||||
### 3. Setup env variables
|
||||
|
||||
`cp ./infra/dev/.env.example ./infra/dev/.env` and fill with values
|
||||
`cp ./infra/dev/.env.example ./infra/dev/.env` and fill with values
|
||||
Most default value should work out of the box, but don't forget to update the database connection string.
|
||||
|
||||
### 4. Build
|
||||
On the frontend:
|
||||
```
|
||||
cd front
|
||||
npm run
|
||||
npm install
|
||||
```
|
||||
|
||||
### 5. Start
|
||||
On the server side:
|
||||
```
|
||||
cd server
|
||||
npm install
|
||||
npm run prisma:migrate
|
||||
```
|
||||
You can also add `npm run prisma:seed` to seed the database with mock data.
|
||||
|
||||
### 5. Auth Setup
|
||||
Right now the only way to authenticate yourself is to setup Google Sign-in in `server/.env`
|
||||
We will add an easier option soon.
|
||||
|
||||
### 6. Start
|
||||
On the frontend:
|
||||
```
|
||||
cd front
|
||||
npm run
|
||||
npm run start
|
||||
```
|
||||
On the server side:
|
||||
```
|
||||
cd server
|
||||
npm run start
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user