README.md

emevents-api

Emevents-api is a RESTful API for the event management systems.

Build With

• Javascript
• Node.js
• Express
• MongoDB
• Mongoose
• Mocha
• Chai
• Nodemon

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

Before you begin, ensure you have met the following requirements:

• Node.js
• MongoDB
• Postman
• Git

🛠 Installation & Set Up

If you dont have node install on your computer, Install node js from https://nodejs.org/en as your JavaScript Runtime Engine

If you installed git you can clone the code to your machine, or download a ZIP of all the files directly.

Download the ZIP from this location, or run the following git command to clone the files to your machine:

Open your terminal and navigate to the project directory.

1. Install Node Modules

   npm install

2. Set up environment variables

   Create a .env file in the root directory of the project and add the following variables

    PORT=YOUR_PORT
    MONGO_URI=YOUR_MONGO_URI

3. Start the development server

   npm start
   

4. You can now access the API on your browser at http://localhost:YOUR_PORT

Test

Test the application using the command

npm test

Deployment

npm run build

Author

👤 Desmond Owusu Ansah

• Github @Owusu-Desmond
• Twitter @DesmondOwusuDev
• LinkedIn @desmond-owusu-ansah
• Dev @desmondowusudev

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a ⭐️ if you like this project!

Acknowledgments

• Microverse

📝 License

This project is MIT licensed.