Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bramirez96/story-squad-be

The backend I built over a two-month internship for the paid version of the Story Squad writing contest app.
https://github.com/bramirez96/story-squad-be

Last synced: 10 days ago
JSON representation

The backend I built over a two-month internship for the paid version of the Story Squad writing contest app.

Awesome Lists containing this project

README 

        
# Story Squad API

[![Maintainability](https://api.codeclimate.com/v1/badges/6590d9f8cbab03268109/maintainability)](https://codeclimate.com/github/Lambda-School-Labs/Labs26-StorySquad-BE-TeamB/maintainability)  [![Test Coverage](https://api.codeclimate.com/v1/badges/6590d9f8cbab03268109/test_coverage)](https://codeclimate.com/github/Lambda-School-Labs/Labs26-StorySquad-BE-TeamB/test_coverage)



Welcome to your `Basic Node API Repository`. Use this to start your own Greenfield Project using nodejs, express and common industry standards.



This repository assumes a handful of industry practices and standards. We strive to keep you on the bleeding edge of the industry and as a result, we have made some opinions for you so that you don't have to; you're welcome.



Read more at 



## Requirements



Labs teams must follow all [Labs Engineering Standards](https://labs.lambdaschool.com/topics/node-js/).



## Getting Started



### Enviornment Variables



- `PORT` - API port (optional, but helpful with FE running as well)

  - The following ports are whitelisted for use with okta

    - 3000

    - 8000

    - 8080

- `DS_API_URL` - URL to a data science api. (eg. )

- `DS_API_TOKEN` - authorization header token for data science api (eg. SUPERSECRET)

- `DATABASE_URL` - connection string for postgres database

- `OKTA_URL_ISSUER` - The complete issuer URL for verifying okta access tokens. `https://example.okta.com/oauth2/default`

- `OKTA_CLIENT_ID` - the okta client ID.

- `TEST_DATABASE_URL` - the URL of the database to run tests on



See .env.sample for example values



### Setup postgres



There are 3 options to get postgresql installed locally [Choose one]:



1. Use docker. [Install](https://docs.docker.com/get-docker/) for your platform

    - run: `docker-compose up -d` to start up the postgresql database and pgadmin.

    - Open a browser to [pgadmin](http://localhost:5050/) and you should see the Dev server already defined.

    - If you need to start over you will need to delete the folder `$ rm -rf ./data/pg` as this is where all of the server data is stored.

      - if the database `api-dev` was not created then start over.

    > When using Docker, you will need to manually create your test database, called `api-test`

2. Download and install postgresql directly from the [main site](https://www.postgresql.org/download/)

    - make note of the port, username and password you use to setup the database.

    - Connect your client to the server manually using the values previously mentioned

    - You will need to create a database manually using a client.

    - Make sure to update the DATABASE_URL connection string with the values for username/password, databasename and server port (if not 5432).

    > Make sure you create `api-dev` to run any queries in Postman or through the swagger documentation, as well as a database called `api-test` to run the Jest tests

3. Setup a free account at [ElephantSQL](https://www.elephantsql.com/plans.html)

    - Sign up for a free `Tiney Turtle` plan

    - copy the URL to the DATABASE_URL .env variable

    - make sure to add `?ssl=true` to the end of this url

    > you'll need separate databases for Jest testing (`api-test`) and Postman/Swagger endpoint testing (`api-dev`)



### Setup the application



- create your project repo by forking or using this as a template.

- run: `npm install` to download all dependencies.

- run: `cp .env.sample .env` and update the enviornment variables to match your local setup.

- run: `npm run knex migrate:latest` to create the starting schema.

- run: `npm run knex seed:run` to populate your db with some data.

- run: `npm run tests` to confirm all is setup and tests pass.

- run: `npm run watch:dev` to start nodemon in local dev enviornment.



> Make sure to update the details of the app name, description and version in

> the `package.json` and `config/jsdoc.js` files.



## Contributing



See the [contributing doc](https://github.com/Lambda-School-Labs/labs-api-starter/blob/main/CONTRIBUTING.md)

for more info.