chore(readmes): cleans up root readme

This commit is contained in:
Dimitrie Stefanescu
2021-01-03 20:11:59 +02:00
parent ce417dd5b2
commit 09de6650f0
-30
View File
@@ -30,36 +30,6 @@ To get started, first clone this repo & run `npm install`. Next, you'll need to
After these steps are complete, run `lerna run dev --stream`. Alternatively, you can `npm run dev` independently in each separate package (this will make for less spammy output).
#### Server Setup Notes
To run the **Server** in debug mode:
- Duplicate and rename `.env-example` to `.env` & fill it in!
- Make sure a postgres instance is running locally, with two databases present, named `speckle2_dev` and `speckle2_test` (or whatever needed to match your .env `POSTGRES_URL` variable).
- Make sure a redis instance is running locally.
- Run `npm install`
- Run `npm run dev:server` 🚀
#### Frontend
To run the **Frontend** locally in debug mode:
- Switch your working directory to `/frontend`
- Run `npm install`
- Run `npm run dev:frontend` from the Server root folder, or `npm run serve` from `/frontend`.
To build the frontend, simply run `npm run build:frontend`.
#### Frontend & Backend
To run both at the same time with one command only, simply run `npm run dev:all`. Take care: for this to work, you should install the frontend dependencies first.
### Testing
The Server is quite thoroughly covered by tests. We'll aim to keep it that way (>90%). Once you have followed the setup steps above, you can run all the tests by hitting `npm run test:server`.
For testing specific functionality, use `NODE_ENV=test mocha --grep ${scope} --watch`. For example, if you want to test the commit services only, you can run `mocha --grep @core-commits --watch`
## Contributing
Please make sure you read the [contribution guidelines](CONTRIBUTING.md) for an overview of the best practices we try to follow.