Unicis Platform Community (free and open source)

Mastodon | | Discord

Unicis Platform Community Edition - an open core, enterprise-ready trust management platform for startups and SMEs.

Please star ⭐ the repo if you want us to continue developing and improving the Unicis Platform! 😀

Subscribe to our newsletter to stay informed.

📖 Additional Resources

Unicis Platform getting started documentation

🛠️ Built With

SaaS-Starter-Kit
Next.js
Tailwind CSS and Atlaskit
Postgres
React
Prisma
TypeScript
SAML Jackson (Provides SAML SSO, Directory Sync)
Svix (Provides Webhook Orchestration)
Retraced (Provides Audit Logs Service)
Endpoints collection (Provided by Osquery)

🚀 Deployment

To Be Done

✨ Getting Started

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

Prerequisites

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

Development

1. Setup

Fork the repository
Clone the repository by using this command:

git clone https://github.com/<your_github_username>/unicis-platform-ce.git

2. Go to the project folder

cd unicis-platform-ce

3. Install dependencies

npm install

4. Set up your .env file

Duplicate .env.example to .env.

cp .env.example .env

5. Create a database (Optional)

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

docker-compose up -d

6. Set up database schema

npx prisma db push

7. Start the server

In a development environment:

npm run dev

8. Start the Prisma Studio

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

npx prisma studio

9. Testing

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

Update playwright.config.ts to change the playwright configuration.

Install Playwright dependencies

npm run playwright:update

Run E2E tests

npm run test:e2e

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

Free and open source community edition - all-in-one tools for security, privacy and compliance team

Applications

🥇 Features

Create account
Sign in with Email and Password
Sign in with Magic Link
Sign in with SAML SSO
Sign in with Google [Setting up Google OAuth]
Sign in with GitHub [Creating a Github OAuth App]
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
Dark mode

✨ Contributing

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

🤩 Community

Discord (For live discussion with the Open-Source Community and Unicis team)
X / LinkedIn / Mastodon (Follow us)
Vimeo (Watch community events and tutorials)
GitHub Issues (Contributions, report issues, and product ideas)

🌍 Contributors

Made with contrib.rocks.

🛡️ License

Apache 2.0 License

unicistech / unicis-platform-ce Goto Github PK

unicis-platform-ce's Introduction