Skip to content
This repository was archived by the owner on Mar 12, 2025. It is now read-only.

Commit a54eea2

Browse files
testflyjetstestflyjets
committed
Deprecates service
1 parent acd3593 commit a54eea2

File tree

2 files changed

+34
-110
lines changed

2 files changed

+34
-110
lines changed

‎.circleci/config.yml

Lines changed: 0 additions & 81 deletions
This file was deleted.

‎README.md

Lines changed: 34 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
1+
# DEPRECATED - JAN 16, 2024 - see https://topcoder.atlassian.net/browse/CORE-208
2+
13
# Skills API
24

3-
* [Prerequisites](#prerequisites)
4-
* [Configuration](#configuration)
5-
* [Local deployment](#local-deployment)
6-
* [Migrations](#migrations)
7-
* [Local Deployment with Docker](#local-deployment-with-docker)
8-
* [NPM Commands](#npm-commands)
9-
* [JWT Authentication](#jwt-authentication)
10-
* [Documentation](#documentation)
5+
- [Prerequisites](#prerequisites)
6+
- [Configuration](#configuration)
7+
- [Local deployment](#local-deployment)
8+
- [Migrations](#migrations)
9+
- [Local Deployment with Docker](#local-deployment-with-docker)
10+
- [NPM Commands](#npm-commands)
11+
- [JWT Authentication](#jwt-authentication)
12+
- [Documentation](#documentation)
1113

1214
## Prerequisites
1315

@@ -59,6 +61,7 @@ Configuration for the application is at `config/default.js` and `config/producti
5961
**NOTE** AUTH0 related configuration normally is shared on challenge forum.
6062

6163
## DB and Elasticsearch In Docker
64+
6265
- Navigate to the directory `docker-pgsql-es` folder. Rename `sample.env` to `.env` and change any values if required.
6366
- Run `docker-compose up -d` to have docker instances of pgsql and elasticsearch to use with the api
6467

@@ -69,8 +72,8 @@ Notice the `--volumes` argument is passed to the `docker-compose down` command t
6972

7073
Setup your Postgresql DB and Elasticsearch instance and ensure that they are up and running.
7174

72-
- Follow *Configuration* section to update config values, like database, ES host etc ..
73-
- Goto *skills-api*, run `npm i`
75+
- Follow _Configuration_ section to update config values, like database, ES host etc ..
76+
- Goto _skills-api_, run `npm i`
7477
- Create database using `npm run create-db`.
7578
- Run the migrations - `npm run migrations up`. This will create the tables.
7679
- Then run `npm run insert-data` and insert mock data into the database.
@@ -82,6 +85,7 @@ Setup your Postgresql DB and Elasticsearch instance and ensure that they are up
8285
Migrations are located under the `./scripts/db/` folder. Run `npm run migrations up` and `npm run migrations down` to execute the migrations or remove the earlier ones
8386

8487
## Local Deployment with Docker
88+
8589
Setup your Postgresql DB and Elasticsearch instance and ensure that they are up and running.
8690

8791
- Configure AUTH0 related parameters via ENV variables. Note that normally you don't need to change other configuration.
@@ -98,32 +102,33 @@ Setup your Postgresql DB and Elasticsearch instance and ensure that they are up
98102

99103
- Once that is done, run the following command
100104

101-
```bash
102-
docker-compose up
103-
```
105+
```bash
106+
docker-compose up
107+
```
104108

105109
- When you are running the application for the first time, It will take some time initially to download the image and install the dependencies
106110

107111
## NPM Commands
108112

109-
| Command                    | Description |
110-
|--------------------|--|
111-
| `npm run start` | Start app |
112-
| `npm run start:dev` | Start app on any changes (useful during development). |
113-
| `npm run lint` | Check for for lint errors. |
114-
| `npm run lint:fix` | Check for for lint errors and fix error automatically when possible. |
115-
| `npm run create-db` | Create the database |
116-
| `npm run insert-data` | Insert data into the database |
117-
| `npm run migrate-db-to-es` | Migrate data into elastic search from database |
118-
| `npm run delete-data` | Delete the data from the database |
119-
| `npm run migrations up` | Run up migration |
120-
| `npm run migrations down` | Run down migration |
121-
| `npm run create-index` | Create Elasticsearch indexes. Use `-- --force` flag to skip confirmation |
122-
| `npm run delete-index` | Delete Elasticsearch indexes. Use `-- --force` flag to skip confirmation |
123-
| `npm run generate:doc:permissions` | Generate [permissions.html](docs/permissions.html) |
124-
| `npm run generate:doc:permissions:dev` | Generate [permissions.html](docs/permissions.html) on any changes (useful during development). |
113+
| Command                    | Description |
114+
| ------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
115+
| `npm run start` | Start app |
116+
| `npm run start:dev` | Start app on any changes (useful during development). |
117+
| `npm run lint` | Check for for lint errors. |
118+
| `npm run lint:fix` | Check for for lint errors and fix error automatically when possible. |
119+
| `npm run create-db` | Create the database |
120+
| `npm run insert-data` | Insert data into the database |
121+
| `npm run migrate-db-to-es` | Migrate data into elastic search from database |
122+
| `npm run delete-data` | Delete the data from the database |
123+
| `npm run migrations up` | Run up migration |
124+
| `npm run migrations down` | Run down migration |
125+
| `npm run create-index` | Create Elasticsearch indexes. Use `-- --force` flag to skip confirmation |
126+
| `npm run delete-index` | Delete Elasticsearch indexes. Use `-- --force` flag to skip confirmation |
127+
| `npm run generate:doc:permissions` | Generate [permissions.html](docs/permissions.html) |
128+
| `npm run generate:doc:permissions:dev` | Generate [permissions.html](docs/permissions.html) on any changes (useful during development). |
125129

126130
## JWT Authentication
131+
127132
Authentication is handled via Authorization (Bearer) token header field. Token is a JWT token.
128133

129134
Here is a sample user token that is valid for a very long time for a user with administrator role.

0 commit comments

Comments
 (0)