Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/erickgbr/tecnical-test-node
https://github.com/erickgbr/tecnical-test-node
Last synced: 10 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/erickgbr/tecnical-test-node
- Owner: ErickGBR
- Created: 2024-06-05T14:23:09.000Z (7 months ago)
- Default Branch: master
- Last Pushed: 2024-06-12T06:01:37.000Z (7 months ago)
- Last Synced: 2024-06-12T11:33:47.724Z (7 months ago)
- Language: JavaScript
- Size: 68.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Node.js CRUD API with SQLite
This project is a CRUD API built with Node.js and SQLite. It manages Authors and Books, providing endpoints to create, read, update, and delete records. Unit tests are included using Jest.
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [API Endpoints](#api-endpoints)
- [Database](#database)
- [Authors](#authors)
- [Books](#books)
- [Running Tests](#running-tests)
- [Contributing](#contributing)
- [License](#license)
## Installation
1. Clone the repository:
```bash
git clone https://github.com/ErickGBR/tecnical-test-node.git
```
2. Navigate to the project directory:
```bash
cd tecnical-test-node
```
3. Install the dependencies:
```bash
npm install
```
## Usage
1. Start the server:
```bash
npm run serve
```
The server will start on `http://localhost:3000`.
## API Endpoints
### Database
- **GET /api/v1/db/**: Retrieve the route to create database tables
### Authors
- **GET /authors**: Get all authors
- **GET /authors/:id**: Get a single author by ID
- **POST /authors**: Create a new author
- Request body:
```json
{
"name": "",
"bio": ""
}
```
- **PUT /authors/:id**: Update an author by ID
- Request body:
```json
{
"name": "",
"bio": ""
}
```
- **DELETE /authors/:id**: Delete an author by ID
### Books
- **GET /books**: Get all books
- **GET /books/:id**: Get a single book by ID
- **POST /books**: Create a new book
- Request body:
```json
{
"title": "",
"summary": "",
"authId":
}
```
- **PUT /books/:id**: Update a book by ID
- Request body:
```json
{
"title": "",
"summary": "",
"authId":
}
```
- **DELETE /books/:id**: Delete a book by ID
## Running Tests
1. Run the tests with Jest:
```bash
npm test
```
## Contributing
Contributions are welcome! Please open an issue or submit a pull request.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.