akinncar / github-stars

:sparkles: Fullstack monorepo web app to add tags on your starred repositories

Try in the Browser

Objective

As the name implies, GithubStars is a web app to list starred repositories from a user, and can manage retrieved repositories' tags (i.e., add, edit, delete, search). It is also a convienant way to look at all starred repos in a table format.

Documentation

The documentation was built with Docussaurus v2 to show developers how to start this project on a local machine. Docs also have an API Reference session containing all endpoints available on back-end. The website is available here.

Technologies

This is a monorepo created with Yarn Workspaces to manage the Server and Client sides. These technologies were picked focusing on Javascript/Typescript. Both packages are hosted and have an automated CI/CD. You can see all technologies used in the README and package.json files of each project. Also, you will see all Production URLs bellow:

• Production Back-end - README
• Production Front-end - README
• Production Documentation - README

License

The app's source code is made available under the MIT license. Some of the dependencies are licensed differently, with the BSD license, for example.

Contact

Akinn Rosa - Github - [email protected]

github-stars's Issues

[client] change interface to type in typescript

[client] Add Storybook

Add storybook to all components and pages on the front-end

[server] Separate api jsdocs

Use JSDOCS annotations on separated .yml files instead of on the root folder in the back-end.