This is a simple REST API EXPRESS app which delivers words (contains 14476 words!) which I've gathered from various 80's Atari computer magazines, articles, reviews and classic computer game title lists.
I created this API in order to use it in my game WordRazer to get random "nerdy" words from this API.
You can query for all words or random words or also add a limit to how many results you want to receive. It is also possible to query for a specific _id.
The api sends back the result in JSON-format.
The API is live at retrocomputerwordsapi.alexdev.se to view it in the browser.
This API is open but does require authentication. To get access follow these steps:
1. Do a POST request to endpoint: api/v1/words/signin and include these params to the body:
username: "free",
password: "access"
2. Copy the returned token (which you get in the response - the token is valid for 1h)
3. Then make the GET request (To any of the available routes) and include an Authorization header with value: Bearer {your token}
voila!
To run this app locally you'll need Node.JS installed. Then just clone it and then run "npm i" to install the dependencies.
In the project directory, you can run:
Which launches the server.
Open http://localhost:3000 to view it in the browser.
The page will reload if you make edits.
With nodemon you will be able to see any errors in the console.
The API has been deployed to Heroku hosting,
Feel free to use it, at this moment it doesn't need any authentication:
https://retrocomputer-words-api.herokuapp.com/
This project was bootstrapped with Create React App.
Using:
- Express.JS - Web framework
- Node.JS - Open source server environment
- MongoDB Atlas - Cloud MongoDB service
- Mongoose - Mongodb object modeling for node.js
- Express-Validator - Express validator Middleware
- JWT - For authentication
- bcrypt - For hashing
Please read [CONTRIBUTING.md] for details on the code of conduct, and the process for submitting pull requests to this project.
- Alexander Bulér Forrest - Initial work - abulerforrest
This project is licensed under the GNU AGPLv3 License - see AGPLv3