Skip to content

Source code for the RESTful API used in my personal website ☁️

License

Notifications You must be signed in to change notification settings

chapmankyle/website-api

Repository files navigation

Website RESTful API ☁️

Deploy status license: GPL-3.0 Release

Official API endpoint is available at https://api.kylechapman.dev/

Official portfolio website is available at https://kylechapman.dev/ 🎉

This repository serves as the source code for the RESTful API that serves content to my website ☁️

Routes 🏄

All routes other than / are protected by Bearer authorization, just to make sure nobody other than myself can touch that data. However, if you really want the data, then it is in the src/data.json file of this repo.

Endpoint Methods Description
/ GET Returns a welcome message.
/all GET Returns all of the information from the API.
/metadata GET Returns the metadata used for SEO in my website.
/experience GET Returns my software development experience.
/education GET Returns my education.
/projects GET Returns my personal projects
/contact GET Returns my contact informaton

Setup 🚀

Clone the repository and navigate to the website-api directory.

# clone the repo
git clone [email protected]:chapmankyle/website-api.git

# navigate to the `website-api` directory
cd website-api

You need to have Bun installed in order to compile from the source code.

Building 🔨

You need to install all the requirements first, so type the following into the terminal of your choice:

# install requirements
bun install

You can now run the RESTful API server by typing the following:

# run locally
bun run dev

The RESTful API is now accessible at http://localhost:8787 🎉