RESTful cloud storage server built with express that uses Firebase Cloud Storage as cloud provider.
Clone the repo:
git https://github.com/MuhamedMagdi/CloudStorage.gitInstall the dependencies:
npm iSet the environment variables:
cp .env.example .env
# open .env and modify the environment variables- Authentication and Authorization
- File CRUD
- API documentation: swagger documentation
- Dockerized
Running locally:
npm run devRunning in production:
npm startDocker:
# building the server image
sudo docker build -t server:v1 .
# run docker container
sudo docker-compose upLinting:
# run ESLint
npm run lint:check
# fix ESLint errors
npm run lint:fix
# run prettier
npm run format:check
# fix prettier errros
npm run format:writesrc/
├── config # ENV and global configurations
├── controllers # Route controllers
├── database # Database connection
├── models # Mongoose models
├── routes # API routes
└── utils # General purpose utility function and classes
Go to /api/v1/api-docs view the list of available APIs endpoints and their specifications.-