janpio / akilli Goto Github PK

Akilli is a platform that provides transcription services for African languages. It aims to bridge the gap in language services for African languages by providing accurate and affordable transcription services.

• Next.js
• Tailwind CSS
• Postgres
• React
• Prisma
• TypeScript
• SAML Jackson (Provides SAML SSO, Directory Sync)
• Svix (Provides Webhook Orchestration)
• Retraced (Provides Audit Logs Service)

Please follow these simple steps to get a local copy up and running.

• Node.js (Version: >=18.x)
• PostgreSQL
• NPM
• Docker compose

Clone or fork this GitHub repository

git clone https://github.com/boxyhq/saas-starter-kit.git

cd saas-starter-kit

npm install

Duplicate .env.example to .env.

cp .env.example .env

To make the process of installing dependencies easier, we offer a docker-compose.yml with a Postgres container.

docker-compose up -d

npx prisma db push

In a development environment:

npm run dev

Prisma Studio is a visual editor for the data in your database.

npx prisma studio

We are using Playwright to execute E2E tests. Add all tests inside /tests folder.

Update playwright.config.ts to change playwright configuration.

npm run playwright:update

npm run test:e2e

Note: HTML test report is generated inside the report folder. Currently suported browsers for test execution chromium and firefox

• Create account
• Sign in with Email and Password
• Sign in with Magic Link
• Directory Sync (SCIM)
• Update account
• Create team
• Invite users to the team
• Manage team members
• Update team settings
• Webhooks & Events
• Internationalization
• Audit logs
• Roles and Permissions

• Billing & subscriptions
• Unit and integration tests
• Dark mode

Thanks for taking the time to contribute! Contributions make the open-source community a fantastic place to learn, inspire, and create. Any contributions you make are greatly appreciated.

Please try to create bug reports that are:

• Reproducible. Include steps to reproduce the problem.
• Specific. Include as much detail as possible: which version, what environment, etc.
• Unique. Do not duplicate existing opened issues.
• Scoped to a Single Bug. One bug per report.

Contributing Guide

• Discord (For live discussion with the Open-Source Community and BoxyHQ team)
• Twitter / LinkedIn (Follow us)
• Youtube (Watch community events and tutorials)
• GitHub Issues (Contributions, report issues and product ideas)

Apache 2.0 License