diff --git a/README.md b/README.md new file mode 100644 index 0000000..305d64b --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +Rap Names Api +
+100Devs created an API to give details of your favorite rappers. + +Link to project: https://rapper-api-100devs-class39.herokuapp.com/ +![21 Savage](https://external-content.duckduckgo.com/iu/?u=https%3A%2F%2Fglamourfame.com%2Fuploads%2F2019%2F03%2F11%2Frapper-21-savage--1552284147.jpg&f=1&nofb=1) + +How It's Made: +
+Tech used: HTML, JavaScript, Node.JS, Express +
+This API is used to retrieve information about your favorite rapper. This API will return the birth name, birth location, and age of the rapper. Express is used to build this API quickly +To use this API, fork this repo and clone the repo to your machine. +Download the node modules using npm init in the terminal. +You must be in the folder using your terminal, so make sure to cd into this repo on your local machine. +Run the server locally using the terminal with the command node server.js. +You now have access to the data via your browser using localhost:8000/API/rapper-name. +Replace rapper-name with the rapper of your choice. +If the rapper's name is not in the API, it will return unknown data. + + +Optimizations +
+We could include more details about the rapper or include more rappers in general with more time. It would also be nice to include an image or video file that one can use through this API. + +Lessons Learned: +
+Express made it easier to set up this API. Express allowed us to listen to a port to run our server on so we can test. We can also use .get() to send files or JSON. +