Initial commit
This commit is contained in:
47
README.md
Normal file
47
README.md
Normal file
@@ -0,0 +1,47 @@
|
||||
# Seer
|
||||
Armco Search and Insights APIs, analytics endpoint, search results retriever, data enrichers, adapters
|
||||
|
||||
|
||||
## About
|
||||
|
||||
This project was created with [express-generator-typescript](https://github.com/seanpmaxwell/express-generator-typescript).
|
||||
|
||||
|
||||
## Available Scripts
|
||||
|
||||
### `npm run dev`
|
||||
|
||||
Run the server in development mode.
|
||||
|
||||
### `npm test`
|
||||
|
||||
Run all unit-tests with hot-reloading.
|
||||
|
||||
### `npm test -- --testFile="name of test file" (i.e. --testFile=Users).`
|
||||
|
||||
Run a single unit-test.
|
||||
|
||||
### `npm run test:no-reloading`
|
||||
|
||||
Run all unit-tests without hot-reloading.
|
||||
|
||||
### `npm run lint`
|
||||
|
||||
Check for linting errors.
|
||||
|
||||
### `npm run build`
|
||||
|
||||
Build the project for production.
|
||||
|
||||
### `npm start`
|
||||
|
||||
Run the production build (Must be built first).
|
||||
|
||||
### `npm start -- --env="name of env file" (default is production).`
|
||||
|
||||
Run production build with a different env file.
|
||||
|
||||
|
||||
## Additional Notes
|
||||
|
||||
- If `npm run dev` gives you issues with bcrypt on MacOS you may need to run: `npm rebuild bcrypt --build-from-source`.
|
||||
Reference in New Issue
Block a user