Story Squad API

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 https://docs.labs.lambdaschool.com/labs-api-strarter/

Quick Guide Video:

https://drive.google.com/file/d/1g6YoAzRyRmPL2EdwqNuUfp_BlxlPC7jS/view?usp=sharing

API Here:

https://story-squad-c-api.herokuapp.com/

Contributors

Michael Barnes	John Daly	Scott Fuston	Dawson Hamm	Jesse Marek	Johan Mazorra	Jack Ross	Jacob Tharp
Web	Web	Web	Web	Web	DS	DS	TPL

Requirements

Labs teams must follow all Labs Engineering Standards.

API documentation

All routes can be viewed in the /api/README.md file

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. https://ds-bw-test.herokuapp.com/)
• DATABASE_URL - connection string for postgres database
• TEST_DATABASE_URL - the URL of the postgres database to run tests on
• 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.
• CC_TEST_REPORTER_ID - id for code climate testing
• JWTSECRET - secret for jwt
• ACCESSKEY - access key for AWS S3 bucket
• SECRETKEY - secret Key for AWS s3 bucket

See .env.sample for example values

Setup postgres

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

1. Use docker. Install for your platform
   • run: docker-compose up -d to start up the postgresql database and pgadmin.
   • Open a browser to pgadmin 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
   • 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
   • 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 for more info.