E-Complaints: A JavaScript repository from adarshaacharya

E-Complaints 💬

A complaint management system to send the compaints to different departments by user. The complaints can be forwaded by admin as per nature of complaints and will be responded by the respective staff.

🛠 Installation & Set Up

Start developing locally.

Step 1: Clone the repo

Fork the repository. then clone the repo locally by doing -

https://github.com/adarshaacharya/E-Complaints.git

Step 2: Install Dependencies

cd into the directory

cd E-Complaints

In the root folder do npm install.

npm install

Step 3: Setup .env

To run the server you will also need to provide the .env variables

create a new file .env in the root
open .env.example
copy the database url and paste it to the .env (make sure that you've installed MongoDB)

And you are good to go

npm run dev

# Server runs on http://localhost:5000

🤝 Contributing

Contributions, issues and feature requests are welcome. After cloning & setting up project locally, you can just submit a PR to this repo and it will be deployed once it's accepted.

⚠️ Note - Commit & PR Title :

It’s good to have descriptive commit messages so that other folks can make sense of what your commit is doing. This project uses Husky prevent bad git commit, git push and more 🐶 _woof!

adarshaacharya/E-Complaints