An open API service indexing awesome lists of open source software.

https://github.com/udofia2/crudwithdatabase

A simple Nodejs app that connect to a database.
https://github.com/udofia2/crudwithdatabase

crud data databse

Last synced: 5 days ago
JSON representation

A simple Nodejs app that connect to a database.

Awesome Lists containing this project

README

        

# CURD WITH DATABASE





Logo

Nodejs is used to create CRUD App That connects to databse.
The following operations can be carried out on the app

- Create Data
- Get's the data created
- Updates the data created
- Deletes the data created

### Built With

- [Nodejs](https://nodejs.org/en/)
- [Expressjs](https://expressjs.com)
- [Monogodb](https://www.mongodb.com/)

## Getting Started

This is an example of how you may give instructions on setting up your project locally.
To get a local copy up and running follow these simple example steps.

### Prerequisites

To use this app in a your local environment, you need to install.

- npm
```sh
npm install npm@latest -g
```

### Installation

2. Fork the repo
```sh
git clone https://github.com/udofia2/CRUDWithDatabase
```
3. Install NPM packages
```sh
npm install
```
4. Environmental setup
```sh
cp sample.env .env
```
5. To start development server
```sh
npm run dev
```

## Usage

This project can be tested using postman, insomnia etc.
available routes are

- GET / (List of created data can be fetched through this route)

- POST / (This route is used in creating a new data)

- PATCH / (Created Data can be edited/updated/modified through this route)

- DELET / (Created Data can be deleted from the database through this rute)

_For more examples, please refer to the [Documentation](https://documenter.getpostman.com/view/7592361/TzRU9mg2)_

## 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

UDOFIA ABASIODONG - Twitter: [@enalsy2](https://twitter.com/enalsy2) - [email protected]

Heroku hosted link: [https://udofia-crud.herokuapp.com](https://udofia-crud.herokuapp.com)

Documentation Link: [Documentation](https://documenter.getpostman.com/view/7592361/TzRU9mg2)_

Project Link: [https://github.com/udofia2/CRUDWithDatabase](https://github.com/udofia2/CRUDWithDatabase)

## ScreenShoots

![Alt text](./screenshots/empty_database.png)
![Alt text](./screenshots/data_created.png)
![Alt text](./screenshots/duplicate_data_check.png)
![Alt text](./screenshots/wrong_ID_checked_during_update.png)
![Alt text](./screenshots/update_successful.png)
![Alt text](./screenshots/successful_data_deletion.png)
![Alt text](./screenshots/invalid_data_check_during_deletion.png)