https://github.com/biggaji/backend-yip

YIP backend workshop demo: A RESTful API implementation.
https://github.com/biggaji/backend-yip

Last synced: about 20 hours ago
JSON representation

YIP backend workshop demo: A RESTful API implementation.

• Host: GitHub
• URL: https://github.com/biggaji/backend-yip
• Owner: biggaji
• License: mit
• Created: 2023-11-06T09:44:19.000Z (almost 1 year ago)
• Default Branch: main
• Last Pushed: 2023-11-16T09:07:38.000Z (12 months ago)
• Last Synced: 2023-11-16T10:25:01.812Z (12 months ago)
• Language: JavaScript
• Size: 206 KB
• Stars: 0
• Watchers: 1
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# backend-yip

[![CircleCI](https://dl.circleci.com/status-badge/img/gh/biggaji/backend-yip/tree/main.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/biggaji/backend-yip/tree/main)

![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/biggaji/backend-yip/ci.yml)

YIP backend workshop demo: A RESTful API implementation written in javascript.

Every part of this project is a sample code which shows how to do the following:

- Create an API server using express framework

- Create a simple REST API that performs CRUD operation on users records in a

  connected mongo database

## How to contribute

1. Fork this project

2. Install the project dependecies by running `npm install` in your project

   directory terminal

3. Create a `.env` file in your project root and set this `MONGO_URI=` to the

   uri of your newly created mongo cluster.

4. Write the request handlers for each of the remaining API resources parts.

5. Test locally to be sure your code works. If you need help, please ask for

   help in the slack channel `#backend`

6. When done push and merge your changes to your forked repo.

7. You will be provided with a submission form before our next workshop.

8. Submission deadline - `Wednesday November 8 2023, 11:59AM`.

## Recommended study links

- [Mongo Tutorial](https://www.youtube.com/playlist?list=PL4cUxeGkcC9h77dJ-QJlwGlZlTd4ecZOA)

- [Mongo Nodejs documentation](https://www.mongodb.com/docs/drivers/node/current/)

### Happy coding guys!