Equalify API

Equalify aims to be the most useful accessibility platform. That means faster scanning, more accurate results, and a more intuitive user interface. We publish Equalify code here so that you can run the platform locally, building new features and fixing issues.

Overview

The Equalify API is written in TypeScript and runs on Node.js. We leverage the Fastify framework for handling HTTP requests/responses.

Our API is stateless and is intended to run ephemerally on serverless environments (currently AWS Lambda). We achieve this by wrapping our code with the @fastify/aws-lambda wrapper. You can still develop locally, however, by starting the Fastify server.

Important Links

Postman Collection GitBook Documentation

Production environment: https://api.equalify.app + Staging environment: https://api.equalify.dev Local environment: http://localhost:3000

Setup

• Clone the repository!
• Install dependencies with yarn install
• Create .env.staging and/or .env.production files- ask any of us for access.
• Start your local server with yarn start:staging or yarn start:prod
• Start developing!

Contribute

Submit bug reports, questions, and patches to the repo's issues tab.

If you would like to submit a pull request, please read CONTRIBUTE.md and ACCESSIBILITY.md before you do.

This project's code is published under the GNU Affero General Public License v3.0 to inspire new collaborations.

Together, we can equalify the internet.