https://github.com/bryanbill/news-api

API to track users and departmental news across an organization
https://github.com/bryanbill/news-api

Last synced: about 1 month ago
JSON representation

API to track users and departmental news across an organization

• Host: GitHub
• URL: https://github.com/bryanbill/news-api
• Owner: bryanbill
• License: mit
• Created: 2022-05-13T08:42:57.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-05-17T19:07:13.000Z (over 2 years ago)
• Last Synced: 2024-11-06T19:53:49.512Z (3 months ago)
• Language: Java
• Homepage:
• Size: 55.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# News API

### (News API - Moringa School Project)

- [Description](#overall-project-description)

- [Setup instructions](#setup-instructions)

- [Technology Used](#languages-and-frameworks)

- [Licence](#Licence)

- [Authors Info](#Author)

## Overall Project Description

- API to track users and departmental news across an organization.

## Setup Instructions

### Clone the repository

HTTPS: `git clone https://github.com/bryanbill/news-api.git`

SSH: `git clone [email protected]:bryanbill/news-api.git`

### Install dependencies

```bash

mvn clean install

```

### Create Tables (if they don't exist) - This is taken care of by default (Seeding)

The API includes a seeder to create the tables. 

### Run the application

```bash

mvn exec:java

```

## Languages and Frameworks

- Java

- Maven

- Spark

- PostgreSQL

## Known Bugs

- Currently, not aware of any. Open to project improvement suggestions.

## Contributing

Contributions to the project are welcome. Fork this repo to contribute.u

## Live Site

#### Available Here: (http://news-api.soloo.me/)

## Licence

[MIT LICENCE](LICENSE)

## Author

- [Brian Omondi](https://github.com/bryanbill)