👋
Welcome to CMS-API
CMS-API is a Backend API for a website used for creating and managing events held by clubs or organizations in colleges.
🏠 Homepage
Local Development Environment Setup
Install all dependencies
npm install
Configure Environment Variables
set your environment variables in a .env
file, use .env.sample
for reference
Run the development server
npm run dev
To run server with live reload enabled use
npm run devc
Linting and Formatting
to lint the code
npm run lint
To fix auto fixable lint issues use
npm run format
Make sure to format your code before submitting a PR.
Contributors
- Github: @utkar5hM
- Github: @priyansh32
🤝 Contributing
Contributions, issues and feature requests are welcome!
Feel free to check issues page. You can also take a look at the contributing guide.
Show your support
Give a
📚 Documentation
Hirearchy Level of userTypes: admin > mod > eventmanager > user
api Documententation will be added soon.
This README was generated with