https://github.com/g-vans/hng-stage-two
https://github.com/g-vans/hng-stage-two
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/g-vans/hng-stage-two
- Owner: G-vans
- Created: 2023-09-11T11:42:08.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-09-11T15:34:16.000Z (over 1 year ago)
- Last Synced: 2025-01-16T10:38:19.097Z (5 months ago)
- Language: Ruby
- Size: 29.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# HNG STAGE TWO
This is a REST API that performs CRUD operations on Person model.
## Table of Contents
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Endpoints](#endpoints)
- [Running Tests](#running-tests)
- [Contributing](#contributing)
## Getting Started
The API is deployed and can be tested [here](https://hng-two.onrender.com).
To get started with the API and run it locally, you can follow these instructions:
### Prerequisites
You need to have the following installed on your system:
- Ruby (version 3.0 or higher)
- Rails (version 7.0.6 )
- PostgreSQL
### Installation
1. Clone the repository:
```bash
git clone [email protected]:G-vans/hng-stage-two.git
```
2. Navigate to the project directory:
```bash
cd hng-stage-two
```
3. Install the required gems:
```bash
bundle install
```
4. Create and migrate the database:
```bash
rails db:create
rails db:migrate
```
5. Start the Rails server:
```bash
rails server
```
Your API should now be running locally at `http://localhost:3000`.
## Usage
The following are the available API endpoints:
### Creating a New Person
To create a new person, make a `POST` request to the following endpoint:
```
POST /api/
```
Include the following JSON data in the request body:
```json
{
"name": "John Doe",
"email": "[email protected]",
"age": 30
}
```
### Fetching Details of a Person
To fetch details of a person, make a `GET` request to the following endpoint:
```
GET /api/:id
```
Replace `:id` with the ID of the person you want to retrieve.
### Modifying Details of an Existing Person
To modify the details of an existing person, make a `PUT` request to the following endpoint:
```
PUT /api/:id
```
Include the updated JSON data in the request body.
### Removing a Person
To remove a person, make a `DELETE` request to the following endpoint:
```
DELETE /api/:id
```
Replace `:id` with the ID of the person you want to delete.
## Endpoints
A summary of the available API endpoints and their functionality.
- `POST /api/`: Create a new person.
- `GET /api/:id`: Fetch details of a person.
- `PUT /api/:id`: Modify details of an existing person.
- `DELETE /api/:id`: Remove a person.
## Running Tests
To run the RSpec tests for this project, use the following command:
```bash
rspec
```
## Contributing
Contributions are welcome! If you find any issues or want to add new features, feel free to create a pull request.