raygervais / athenaeum

Sharing your favorite books has never been easier. What Athenaeum brings to the table is the ability to login and create a repository of your favorite books, you will be able to share your favorite books with other users on the platform, and find users who are into similar books as yourself. You'll be able to see trending books so you can always stay up-to date with what books might be enjoyable for you to read based on your likes. Athenaeum will implement a minimalistic design to allow for functional UI design choices.

raygervais

Environment:
  Hostname: Malachor III
  System: Debian 12
  Environment: Gnome
  Editor: 
    - VS Code
    - Helix
    - Neovim
  Shell: Fish
  Font:
    - Mononoki / Fantasque Sans Mono
    - Iosevka Curly
    - Jetbrains Mono
  Color Schemes: 
    - Nord
    - Solarized
    - Monokai Pro
  Ansible Setup: <WIP>

Career:
  Title: Senior Cloud Engineer
  Languages:
    - Golang
    - Rust
    - Python

Interests:
- Cloud Engineering
- Open Source
- Systems Programming
- Mobile Application Development

athenaeum's Issues

Create Docker Container for E2E Pipeline Concept

Describe the bug
Create the basic Docker Container which builds a Hello World program in Golang

Create Initial Color Scheme

Is your feature request related to a problem? Please describe.
To fuel the design process, we need a color scheme to build our platform with.

Describe the solution you'd like
A color scheme which work for the primary theme (Dark mode?).

Additional context
We can use coolors.co/ to help with this, and save as a collection if interested.

Create Docker front-end

Describe the bug
Similar to back-end, let's create a multistage Docker build of the front-end which can be self-hosted.

Front-end UI Testing

Describe the bug
To ensure that we have end-to-end testing of the code base, let's ensure that the front-end also has UI tests.

Create Contextual Issue Labels

Describe the bug
In order to better organize features, bugs, enhancements etc, let's create some better labels that have a clear separation between:

• Infrastructure
• CI/CD
• Frontend
• Backend
• Documentation

Integrate Open Library APIs to New Book API Call

Describe the bug
When a user submits the name of a book, author, we want to look up it's ISBN and info from https://openlibrary.org/ which has a fantastic API. This will allow us to tailor our models around their returned data.

Implement POC Layouts

Describe the bug
Implement the design concepts by @Grommers00 on the front-end to show the following layouts:

• Home
• Book Detail
• Book Collection

Set-up our react routing within the frontend

Is your feature request related to a problem? Please describe.
React routing needs to be set-up to ensure that we have a good system and folder structure for our react front end.

Describe the solution you'd like
Easy to navigate front end folder system.

Document and Create Coding Practices, Linters, Semantics

Describe the bug
To better ensure good coding practices as we embark on this software idea, let's setup linters and style guides which #3 will report valid / not valid, along with our local editors.

Document POC Software Stack

Describe the bug
To better understand from a high level of the platform, let's document the software stack (frontend, backend, database etc) that we're proposing to use.

Documentation on what to upgrade at different releases.

Is your feature request related to a problem? Please describe.
Versions can change dramatically and need to be manually updated to ensure it is easy to track where the problem lies.

Describe the solution you'd like
I would like to create documentation of all the things that could grow to be out-of-date.

Additional context
Just a simple list in the documentation, e.g. our go.mod, and our docker-containers that can have varying versions as we progress, and that those are maintained as we move forward as a project.

Add: Hello World React Front-end

Describe the bug
A clear and concise description of what the bug is.

This fixes #6 once completed. We have the Golang back-end version, and now want a front-end equivalent.

This starting will be built upon.

Add Semantic UI to Front-end

Describe the bug
Let's leverage Semantic UI ala @Grommers00 recommendation on the front-end, so that we have a standardized UI Library to leverage in our components.

Add Database Connection to Back-end and basic Go Data Models

Describe the bug
Let's add a SQLite Database Connection to the back-end so that we can start exploring persistence and data models.

Suggestions: Gorm

Integrate Github Actions

Is your feature request related to a problem? Please describe.
In order to have constant feedback on the state of our codebase, let's add GitHub Actions to do linting, build, and test on each PR / Push.

Leverage a release-management tool

Describe the bug
So that we can utilize Git tags and Gitihub's release management tool, let's try https://github.com/containerd/release-tool or similar to ease the release management concept.

adds: Contribution Documentation

Describe the bug

Ensure that we are leveraging a standard contribution format, including commit message prefix.

Create Basic REST API Back-end

Describe the bug
Now that we have a basic back-end, let's ensure that it can start providing value by adding the essential REST API endpoints for:

• Books
  • GET / POST / DELETE / UPDATE
• Collections
  • GET / POST

Publish and Tag Release Concept to Dockerhub

Describe the bug

While discovering how to do releases, let's ensure we have a Github Actions Pipeline which publishes our final container(s) to Dockerhub.