OpenMind Academy API

A RESTful API for an education institute
Explore the docs »
Report Bug · Request Feature

About The Project

A simple API for CRUD operations. The objective of this project is to try native mongodb driver and schema. Database schemas and available endpoints are listed below 🔻

• 📃 Student schema
• 📃 Course schema
• 🔁 Student endpoints
• 🔁 Course endpoints

A list of commonly used resources that I find helpful are listed in the acknowledgements.

Built With

• Express
• Mongo DB Atlas

Getting Started 👉

To get a local copy up and running, open your terminal in a favoured location and follow these simple example steps.

git clone https://github.com/thusarasenanayake/openmind-academy-api.git openmind-academy-api
cd openmind-academy-api
npm install

After successful installation, configure these settings related with .env.example file in config folder.

- Rename .env.example to .env
- Replace <MONGODB_URI> with your MongoDB connection string
    example for local db : MONGODB_URI=mongodb://localhost:27017/
    example for MongoDB Atlas: MONGODB_URI=mongodb+srv://name:<password>@cluster0.wszwp.mongodb.net/test

And then run the project by

npm start

Roadmap 🛫

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact 📬

Project Link: https://github.com/thusarasenanayake/openmind-academy-api

Acknowledgements

• README Template
• Choose an Open Source License
• JSend
• Faker