Exercise Tracker Microservice

I’m really proud of how this project turned out. Please let me know if there is anything else that I can do to improve on this project. Thanks!

The database right now is blocked to prevent abuse, but it works great on a local Db.

Glitch: https://classy-doom.glitch.me/
Github: https://github.com/fendermaniac/exercise-tracker-microservice

1 Like

From the website, “API Design Guide”:

All APIs must include documentation targeted at the developer that will consume your API.

Creating an API for your own consumption is fine, but if you’re going to make it available for anyone (users or developers) to use, it needs documentation - what it does, how to use it, etc,… Of course, if you’re going to make an API solely for your own consumption (meaning, making your own app and ‘selling’ it), then the front end you attach to it had better be amazing.

I don’t speak for freeCodeCamp, but my understanding of what’s required here is a full-stack app where you attach a front end that communicates to consumers of your api (other developers) what your service does and how to use it. You could also attach a sample front end as an example of what can be done with your service, which is what I see when I look at your project page, but without documentation in either case, it’s incomplete.

That being said, I wasn’t so clear on what exactly I needed to do when I was completing these projects myself.

https://apiguide.readthedocs.io/en/latest/build_and_publish/documentation.html

Documentation was definitely something that I had not put a ton of thought into, since I was focused on primarily getting the core functionality out. I’ll definitely go back and make sure these projects include proper documentation.

Thanks for the guide!

1 Like