- Erick Otieno Okumu
This is an Organizational Rest API that queries and retrieves scoped news and information within an organization.
A user visiting the news portal Api site will be able to:
- Add New Departments & and also view local departments present.
- Add new User/s' to andy department desired.
- Add news in a particular department and view the news under the directed department.
- Use of version control. ie. Git
- Java SDK & Environment.
- Java IntelliJIDEA Community.
- Gradle.
- PostgreSQL
- Depending on your preffereable method of acquiring the Application to your local machine, you might as well try:
- Forking the repository to your repositories.
- Cloning the forked repository or cloning directly from my repository.
- Finally run the project on your IntelliJIDEA
$ gradle build
,$ gradle run
in your projects terminal.
- Method: GET
- Route: /
{ message: "Hello there Netizen! WELCOME to NEWS-PORTAL-API mainpage." }
- The returned Json is as seen above.
- Method: GET
- Route:
/departments
- Method: GET
- Route:
/departments/:id
- Method: GET
- Route:
/departments/:id/sortedNews
- Sort news in accordance to time passed since it was posted.
- Method: GET
- Route:
/users/:id
- Java
- Java Spark*
- PostgreSQL
- Postman
~ At the moment there are no known bugs, but that is as if you come across any bug or functionality that fails, please feel free to reach out.
~ For any inquiries or future git collaborative projects, reach out to:
Email: [email protected]
Copyright 2020 Erick Otieno Okumu
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.