Add comprehensive README with detailed project information#83
Open
benaiah-muga wants to merge 1 commit intobos-com:mainfrom
Open
Add comprehensive README with detailed project information#83benaiah-muga wants to merge 1 commit intobos-com:mainfrom
benaiah-muga wants to merge 1 commit intobos-com:mainfrom
Conversation
|
|
||
| GreenCode is an API core system designed to support esm_greencode . | ||
| It consists of a **Spring Boot backend API** | ||
| GreenCode is a comprehensive full-stack system designed to support environmental, sustainability, and community-impact projects under Bos-Com. It consists of a **Spring Boot backend API** and a **React frontend**, with future integrations planned for enhanced functionality. |
Contributor
There was a problem hiding this comment.
you can remove the full-stack note because this repo is for APIs
Contributor
RonaldRonnie
left a comment
RonaldRonnie
left a comment
There was a problem hiding this comment.
This is a solid PR and its really cool. I would like you to make the changes that i have commented in so that we have this merged
| - **CORS Configuration**: Cross-origin resource sharing support | ||
| - **Validation**: Input validation and error handling | ||
| - **Logging**: Comprehensive logging for debugging and monitoring | ||
|
|
Contributor
There was a problem hiding this comment.
This should be in the frontend repo called esm-greencode
| │ ├── api/ # API documentation | ||
| │ ├── architecture/ # System architecture docs | ||
| │ └── deployment/ # Deployment guides | ||
| ├── greencode-frontend/ # React frontend application |
Contributor
There was a problem hiding this comment.
This is for the APIs not the frontend as its stated here
| - **Maven**: Build and dependency management | ||
| - **Docker**: Containerization | ||
|
|
||
| ### Frontend |
Contributor
There was a problem hiding this comment.
This is not part of this Project
|
|
||
| 5. **Access the application** | ||
| - **Backend API**: http://localhost:8080 | ||
| - **Frontend**: http://localhost:3000 |
Contributor
There was a problem hiding this comment.
this should be removed
|
|
||
| #### Frontend Setup | ||
|
|
||
| 1. **Navigate to the frontend directory** |
Contributor
There was a problem hiding this comment.
No frontend here in this repo
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds a comprehensive README.md that addresses issue #68.
Changes
Related Issue
Addresses #68: Add a detailed README file for better project understanding
Testing