shrey27tri01 / canvasboard-backend

Canvasboard Backend built on NodeJS๐Ÿš€

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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!

About

Canvasboard Backend built on NodeJS๐Ÿš€


Languages

Language:JavaScript 98.4%Language:Shell 0.9%Language:Dockerfile 0.7%