Skip to content

ThalKod/typescript_circle_api

Repository files navigation

Circle - Typescript API

This is the Typescript version of the API of circle, you can check the React client Here

Built With:

  • Typescript - TypeScript is a typed superset of JavaScript that compiles to plain JavaScript.
  • Node Js - A JavaScript runtime built on Chrome's V8 JavaScript engine.

Documentation

Requirements

  • ffmpeg - FFmpeg is a collection of libraries and tools to process multimedia content such as audio, video, subtitles and related metadata.
  • A Subscrition to FIlestack API - The File Handling Service for Developers
  • MongoDB - Database Solution

Installation

clone the repo

 $ git clone https://github.com/ThalKod/typescript_circle_api.git

create a .env file at the src/ of your project:

#JWT
JWT_SECRET = YOUR_JWT_KEY
JWT_REFRESH_TOKEN_SECRET = YOUR_REFRESH_JWT_KEY

#Database
DB_URL = DATABASE_URL

#Filestack
FILESTACK_API_KEY= YOUR_FILESTACK_API


#API
API_BASE_URL = /api/v0

Install and run the api

 $ yarn install
 $ yarn start:dev

API running on localhost:3080

Contribution

Feel Free to contribute, PR are the most welcome :).

License

MIT License

Copyright (c) 2019 Thal Marcelin

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

Typescript version of the api of React Video Sharing

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •