feat: update Dockerfile to copy all Python files and increment version in Makefile; add README with project details
All checks were successful
Build and Push to Private Registry101 / build (push) Successful in 10s
All checks were successful
Build and Push to Private Registry101 / build (push) Successful in 10s
This commit is contained in:
@@ -11,6 +11,6 @@ COPY ./requirements.txt /code/requirements.txt
|
||||
RUN pip install --no-cache-dir --upgrade -r /code/requirements.txt
|
||||
|
||||
|
||||
COPY ./papi.py /code/
|
||||
COPY ./*.py /code/
|
||||
|
||||
CMD ["python3", "papi.py", "--port", "8912"]
|
||||
2
Makefile
2
Makefile
@@ -1,5 +1,5 @@
|
||||
ENV=dev
|
||||
VER=2
|
||||
VER=3
|
||||
TAG=${ENV}-${VER}
|
||||
REGISTRY=kube-reg.fairfaxmedia.net
|
||||
SVC=papi/svc1
|
||||
|
||||
57
README.md
57
README.md
@@ -0,0 +1,57 @@
|
||||
# Posts API
|
||||
|
||||
This is the Posts API project, a simple API for managing blog posts.
|
||||
|
||||
## Table of Contents
|
||||
- [Installation](#installation)
|
||||
- [Usage](#usage)
|
||||
- [Endpoints](#endpoints)
|
||||
- [Contributing](#contributing)
|
||||
- [License](#license)
|
||||
|
||||
## Installation
|
||||
|
||||
1. Clone the repository:
|
||||
```bash
|
||||
git clone https://git.fairfaxmedia.net/posts-api/papi-py.git
|
||||
```
|
||||
2. Navigate to the project directory:
|
||||
```bash
|
||||
cd papi-py
|
||||
```
|
||||
3. Install the dependencies:
|
||||
```bash
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
To start the server, run:
|
||||
```bash
|
||||
python3 papi.py
|
||||
```
|
||||
|
||||
## Endpoints
|
||||
|
||||
### GET /posts
|
||||
Retrieve a list of all posts.
|
||||
|
||||
### POST /posts
|
||||
Create a new post.
|
||||
|
||||
### GET /posts/{id}
|
||||
Retrieve a specific post by ID.
|
||||
|
||||
### PUT /posts/{id}
|
||||
Update a specific post by ID.
|
||||
|
||||
### DELETE /posts/{id}
|
||||
Delete a specific post by ID.
|
||||
|
||||
## 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.
|
||||
Reference in New Issue
Block a user