Giter Site home page Giter Site logo

podcast-community-api's Introduction

Podcast Community Api

Sites

  • api (slash redirects to docks)
  • api-dev (slash redirect to docks)

Setup

This app is setup to run in a docker container initiated from the main repo but before you do that you need to run cp .env.dist .env and then set your JWT_SECRET (same as client) and add your X_LISTENAPI_KEY instructions on how to get your own listennotes key kan be found her.

Once you have all this setup you go to the main repo and follow the instructions there.

Note that it's possible to run this application just bye using:

yarn yarn start

or

npm install npm run start

But you will have to configure and set up your own mongodb if you chose to do so

Development

Any change should trigger a restart of nodemon in the container (same if your just using yarn start)

Mirgations

Migrations can be created and run with yarn md-seed run inside the container note that new sedders should be added to the /seeders directory and imported into the md-seed-config.js note that the paths for imports should start with ../dist/ this is importent since we need to run the transpield versions of the src files to run this on the server, this also means that you will need to run yarn build localy before running the seeders (and re run that comand if any changes that your seeders are effected bye has been made in src).

Also note that if you are runing the docker containers with production settings (using Dockerfile_Prod and docker-compose.yml) you will need to run both yarn build-seeders and yarn build-seeder-conf before building the containers this creates transpield versions of the fiels that Dockerfile_Prod will copy into the container

For more instructions on how to write a seeder take a look at md-seed

Linting

Workspace Settings

Workspace settings found in .vscode/settings.json If you are not using vs code please add corresponding settings for your editor. It's also recomended to install the folowing plugins for vs code:

ESLint Prettier Flow Language Suport

These plugins allong with the workspace settings will help you to auto-format you code on save as well as give you tipps on how to writ better code

Flow

To install flow on your machine: brew install flow (for mac & linux) npm install --global flow-bin (for windows)

Husky

Precommit-hook added which runs eslint to check that the linting rules are beeing followed, if there are any errors you will be forced to fix them befor you commit

Usage

podcast-community-api's People

Contributors

sebastiangers avatar

Watchers

 avatar  avatar

podcast-community-api's Issues

update to listennotes v2

I over drew my request quota on v1 by mistake so this seams lika a good opportunity to change to v2

Bugfix for EventController

when type is 'follows' we should check the selected users type and handle the setting of the event type accordingly

Create Dockerfile for production

Current Dockerfile does not transpile code to es5 a realtime transpiler is used instead, this is slow and not good for production, so I should chagne it...

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.