Skip to content

Latest commit

 

History

History
78 lines (56 loc) · 4.25 KB

README.md

File metadata and controls

78 lines (56 loc) · 4.25 KB

Canvasboard Backend

All Contributors

Overview 👀

Canvasboard is an interactive board with plugins focusing on replacing the need of multiple platforms for teaching, presenting, managing or explaining your ideas.

The interactive plugins are built using web technologies to ease your work right within a single platform, this repo adds the esence of being a true full stack project.

Running Backend 🏃🏻‍♂️

> Clone the repo
> $ cd canvasboard-backend/apis
> $ npm install
> rename .env_template to .env
> fill in the credentials in .env files

Local Run 💻

> $ cd canvasboard-backend/apis
> $ npm start
> APIs runs on port 4000

Docker Run 🚢

> make sure you have docker up and running
> make sure port 4000 is free
> set node_env=prod in .env file
> $ cd canvasboard-backend
> $ docker-compose up --build
> APIs runs on port 4000

API Docs 📘

> cd canvasboard-backend/apis/apiDocs/
> select the folder depending the flow
> make sure you have postman installed
> import the <filename>.postman_collection in postman

Tech Stack 🧐

docker express javascript mongodb nginx nodejs

Contributors ✨

Thanks goes to these wonderful people (emoji key):


I'm Navaneeth Nivol

💻 🚧

Ayon Pal

💻

Asish Raju

💻 🚧

This project follows the all-contributors specification. Contributions of any kind welcome!