Scope Out the Project - Githubissues

christianareas / resume

An over-engineered version of my resume, with its own database, API, and custom React hook for the API's documentation. 😅

1 stars 0 forks source link

Scope Out the Project #4

Open christianareas opened 1 year ago

christianareas commented 1 year ago

Domains:

resume.areas.me: Landing page (the resume).
resume.areas.me/docs: Docs.
resume.areas.me/docs/api: API reference.

High-Level To-Do’s:

[x] Design the API with an OpenAPI file.
[ ] Create a module that parses the OpenAPI file and creates React components.
[ ] Style the components with Tailwind CSS.
[ ] Build out the reference with more documentation.
[ ] Build the API.
[ ] Use the API to create the landing page (to display the resume).
[ ] Add guides and how-to’s.

Future: Make service available at resume.love!

christianareas commented 1 year ago

NPM Module subtasks:

[x] Use the React Context API to provide data from internal function to components.
[x] Test whether the module passes data from user’s file to its OpenAPI components.
[x] Set up OpenAPI data type definition.
[ ] Set up OpenAPI components.
[ ] Set up configuration files and scripts.
[ ] Document npm module.
[ ] Add Docusaurus site and publish to GitHub Pages.
[ ] Publish npm module (beta).