🔐 sdlogin - The login service for Curio SD

This project is the login service for Curio SD. It is open-source for educational purposes.

📦 Getting Started

This is a Laravel application. To get started, clone the repository and install the dependencies:

git clone https://github.com/curio-team/sdlogin.git
cd sdlogin

Tip

On production you may want to use composer install --no-dev to avoid installing development dependencies.

composer install

Tip

If you get errors during the composer install, make sure you have the correct PHP version and extensions installed (like sodium). » Read how to install PHP extensions on Windows

npm install

Then, copy the .env.example file to .env and configure your environment variables:

cp .env.example .env

Generate the application key:

php artisan key:generate

Ensure the OAuth keys are generated:

php artisan passport:install

Finally, run the migrations:

php artisan migrate

You can now start the Vue development server and the Laravel application:

npm run dev
php artisan serve

🚀 Adding SD Login to your project

1. Ask a teacher to create a new client application for you.

2. Install the curio/sdclient package

   composer require curio/sdclient

3. Follow the instructions in the sdclient README

👷‍♀️ Contributing

We welcome contributions from the community. Please see the contributing guide for more information.