README.md

AFKBuilder API

^{version: 0.1.0}

AFKBuilder's API provides a backend for the AFKBuilder frontend that allows users to sign up, publish comps, and search comps.

Getting Started

This project is powered by Strapi v4. See https://docs.strapi.io/developer-docs/latest/getting-started/introduction.html for more information about Strapi.

Prerequisites

To compile, you must have NodeJS >=16.13.1 installed.

Recommended to use yarn package manager for this project.

Installing

1. Clone a copy of the repository
   1. cd /project/directory
   2. git clone https://github.com/Dae314/afkbuilder_api.git
2. Install the necessary packages
   1. cd /project/directory/afkbuilder_api
   2. yarn install
3. Start up a development environment using yarn
   1. yarn run dev

Deployment

TBD

Built With

• NodeJS - JS Development Environment
• Strapi - Headless CMS

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Dae314 - Maintainer - Dae314

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

• PurpleBooth - for the README.md and CONTRIBUTING.md templates