The Igbo API Editor Platform is the admin platform used by our translators and audio recorders to directly contribute to the Igbo API
The platform is deployed at https://editor.igboapi.com
This is a platform heavily used by our volunteer translators and audio recorders we have a home base Notion page for Volunteers to get onboarded.
Click here to read through the editor guidelines.
Contributions are always welcome. Before contributing please read the Contribution Guide.
This is an open-source project that requires that you create your own Firebase account.
Note: This project requires at least Java JDK 1.8. You can download Java SE 15 here
Note: If this is your first time running this project, you must request access to the Firebase project to start developing. Reach out to @ijemmao. to get access.
Clone the repo:
git clone https://github.com/ijemmao/igbo-api-admin.git
If you don't have Firebase globally install, run the following command:
npm install -g firebase firebase-cli
Install the Firebase project's dependencies:
cd functions/
yarn install
And then the regular project's dependencies:
cd ../
yarn install
Then log into your Firebase account by running:
npx firebase login
This project requires there to be a production and staging Firebase project to enable authentication, functions, and firestore.
Go to Firebase and creating two new projects:
- A production project
- A staging project
Once you've created your two new projects, go to the .firebaserc in the root directory of the project,
and replace the igbo-api-admin and igbo-api-admin-staging with your production project name in "default"
and your staging project name in "staging":
{
"projects": {
"default": "<production_project_name>",
"staging": "<staging_project_name>"
}
}Now that you have your project aliased in .firebaserc, we want the project to start using those projects.
Within index.tsx, the following line of code looks for either your production or staging project service account:
const productionServiceAccount = config?.runtime?.production_service_account;
const stagingServiceAccount = config?.runtime?.staging_service_account;
// ..
const serviceAccount = config?.runtime?.env === 'production' ? (() => {
// ..
return {
projectId: productionServiceAccount?.project_id || localProductionServiceAccount.project_id,
private_key: `${productionServiceAccount?.private_key || localProductionServiceAccount.private_key}`,
client_email: productionServiceAccount?.client_email || localProductionServiceAccount.client_email,
}
})() : (() => {
// ..
return {
projectId: stagingServiceAccount?.project_id || localStagingServiceAccount.project_id,
private_key: `${stagingServiceAccount?.private_key || localStagingServiceAccount.private_key}`,
client_email: stagingServiceAccount?.client_email || localStagingServiceAccount.client_email,
};
})();You want to save your prod-firebase-service-account.json and staging-firebase-service-account.json in /functions!
Once you save those files in /functions, you're own Igbo API Editor Platform is ready to go!
There are two options when spinning up a local version of the Igbo API:
Docker is a software that allows developers to run self-contained apps on any machine.
To start up the Igbo API with Docker, run:
yarn start:docker
When you're done running the Igbo API, make sure to run:
yarn stop:docker
to end the processes and free up the used ports.
Follow the instructions in the Igbo API and start the local development server. You should be able to interact with the API at http://localhost:8080
With API running, in another tab, start the dev project with:
yarn dev
You should now be able to access the editor platform at http://localhost:3030 🎉
Note: This will spin up a local version of the Firebase project igbo-api-admin-staging which
is used for development purposes. Only Firebase Functions are getting emulated, so that means
that any users that create accounts and log in are stored in the project real Authentication.
If you encounter this error - Error: Cannot find module '/root-path/igbo-api-admin/functions/index.js'. Please verify that the package.json has a valid "main" entry - build the project by running:
yarn build:dev
Then go back to step 5 above.
Login: You can login with the email admin@example.com and the password password
For words and examples, you will need to make a POST request to the following route:
/api/v1/test/populate
For example:
http://localhost:8080/api/v1/test/populate // POST
After about 20 seconds, if you see the ✅ Seeding successful. message in your terminal,
then you have successfully populated your database!
Note: Restart your Docker after the POST request to make sure that you have all the words in your database.
Why can't I use Docker for seeding?
You can use Docker but it will seed the wrong MongoDB. Instead of seeding the igbo_api database,
it will seed the igbo_api_testing database which is only used for testing and not development.
For genericWords, you can make a POST request to http://localhost:3030/test/genericWords
If you would like to create a production build of the project, follow these steps.
Build the Firebase production project:
yarn build
Start the project:
yarn start
In another tab, start up a local instance of the Igbo API with:
yarn start:docker
Note This will spin up a local, production-style version of your Firebase project which can be used for production. It's not recommended to develop in this environment, but it is helpful to use for local testing purposes.
You should now be able to access the editor platform at http://localhost:3030
This project uses Cypress for frontend tests.
Docker is also used to spin up local instances of the Igbo API.
Before running any test, make sure to build the project locally:
yarn build:dev
You have two options of running Cypress tests:
To run the server and open the Cypress testing environment, run:
yarn test
To run the Cypress tests headless, start the CI Docker file in one terminal:
yarn start:docker:ci
In another terminal, run:
yarn test:ci
http://localhost:8081 - The test result Dashboard to show all passing and failing tests
Note If your Docker instance is unable to run, try running yarn docker:stop
and then try starting it up again.
All tests run against a built development project, make sure that you've built your project with yarn build:dev when testing.