Git Product home page Git Product logo

audcast-api's Introduction

Audcast API

REST API for Real-time Audio Podcast platform using Socket.io and WebRTC.

API Documentation

https://documenter.getpostman.com/view/17116314/2s93CUGVHz

API Endpoints

The application uses multiple Restful APIs to perform various actions. APIs working in this application are listed as follows:

API Request Operation
/send-otp POST Generate OTP and send it via phone or email
/verify-otp POST Verify OTP and register the user
/activate POST Activate the account
/refresh GET Refresh the access token
/logout POST Logout user
/rooms GET Get all the public rooms
/rooms POST Create new room
/rooms/:id GET Get room with {id}
/rooms/:id PUT Update room with {id}
/rooms/:id DELETE Delete room with {id}
/rooms/my-rooms GET Get rooms of current logged-in user

How to Install

Using Git (recommended)

  1. Clone the project from github. Change "myproject" to your project name.
git clone https://github.com/bskumawat09/audcast-api.git

Using manual download ZIP

  1. Download repository
  2. Uncompress to your desired directory

Install dependancies

  1. Move to the directory where your project is stored.
  2. Run the follwoing command.
npm install

Setting up environment

  1. You will find a file named .env.example on root directory of project.
  2. Create a new file by copying and pasting the file and then renaming it to just .env
    cp .env.example .env
  3. Change the values of the file to your environment. Helpful comments added to .env.example file to understand the constants.

How to run

Running API server locally

node app.js

You will know server is running by checking the output of the command node app.js

Listening on port: 5000
Database connected

Stopping API server

Press CTRL+C

audcast-api's People

Contributors

bskumawat09 avatar

Watchers

 avatar

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.