Skip to content

Commit

Permalink
Main README improved with sections highlights
Browse files Browse the repository at this point in the history
- CONTRIBUTING file added
  • Loading branch information
juanroldan1989 committed Jan 18, 2025
1 parent 13b40e5 commit b574346
Show file tree
Hide file tree
Showing 3 changed files with 76 additions and 20 deletions.
54 changes: 54 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# Contributing

Contributions are welcome and greatly appreciated! If you would like to contribute to this project, please follow these guidelines:

1. **Fork the Repository**

Click the "Fork" button at the top right of this page to create your own copy of the repository.

2. **Create a Branch**

Create a branch for your feature or bug fix:

```bash
git checkout -b feature/your-feature-name
```

3. **Add/Edit Applications**

To add a new Flask application:

- Create a new folder with the application name.
- Include the following files:

-- `Dockerfile`: Defines how the application will be containerized.
-- `app.py`: The main Flask application logic.
-- `test_app.py`: Unit tests to validate the correctness of the API.
-- `requirements.txt`: List of dependencies.
-- `README.md`: Documentation for the application.

4. Update the bash script and GitHub Actions workflow if needed.

5. Run Tests

Ensure your changes do not break existing functionality by running the tests:

6. Commit Changes

Write clear and concise commit messages:

```bash
git commit -m "Add: Description of your change"
```

7. Push Changes

Push your branch to your forked repository:

```bash
git push origin feature/your-feature-name
```

8. Open a Pull Request

Navigate to the original repository and open a pull request (PR). Provide a detailed description of your changes and why they should be merged.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2025 Juan Roldán
Copyright (c) [2025] Juan Roldán

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
40 changes: 21 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,23 @@
# Applications

A collection of simple yet powerful microservices designed for cloud-native applications.
![Build Status](https://img.shields.io/github/actions/workflow/status/juanroldan1989/applications/ci.yml)
![License](https://img.shields.io/github/license/juanroldan1989/applications)
![Last Commit](https://img.shields.io/github/last-commit/juanroldan1989/applications)

_A collection of simple yet powerful microservices designed for cloud-native applications._

![Project Logo](https://elogroup.com/wp-content/uploads/2024/04/WhatsApp-Image-2024-04-18-at-15.57.23-1024x574.jpeg)

## Table of Contents

1. [Introduction](#introduction)
2. [Contents](#contents)
3. [Use Cases](#use-cases)
4. [Launch](#launch-applications)
5. [Contributing](#contributing)
6. [License](#license)

# Introduction

This repository serves as a portfolio of reusable Flask applications, each one designed to be modular, lightweight

Expand Down Expand Up @@ -86,25 +103,10 @@ cd scripts
./docker-clean-up.sh
```

# Adding Applications

To add a new Flask application:

1. Create a new folder with the application name.
2. Include the following files:

- `Dockerfile`: Defines how the application will be containerized.
- `app.py`: The main Flask application logic.
- `test_app.py`: Unit tests to validate the correctness of the API.
- `requirements.txt`: List of dependencies.
- `README.md`: Documentation for the application.

3. Update the bash script and GitHub Actions workflow if needed.

# Future Plans
# Contributing

Extend the portfolio with more Flask services for additional use cases.
Contributions are welcome and greatly appreciated! If you would like to contribute to this project, please follow the guidelines within [CONTRIBUTING.md](CONTRIBUTING.md).

# License

This project is licensed under the MIT License. See the `LICENSE` file for more details.
This project is licensed under the terms of the [MIT License](LICENSE).

0 comments on commit b574346

Please sign in to comment.