OneBoard

Running

Required

• Docker
• Docker Compose
• Linux, MacOS, or Windows (via WSL2)
• PHP Composer

(see the laravel docs for more information on how to install these).

Installing & Running

Run the following commands in your terminal:

# install PHP dependencies
composer update
composer install

# use example environment configuration
cp .env.example .env

# start the application in the background
./vendor/bin/sail up -d

# create application key
./vendor/bin/sail artisan key:generate

# create the database and populate it with fake data
./vendor/bin/sail artisan migrate
./vendor/bin/sail artisan db:seed

# launch the front-end build
./vendor/bin/sail npm install
./vendor/bin/sail npm run dev

# Run this to stop the application
./vendor/bin/sail stop

This project is compatible with VSCode Dev Containers.

Documentation

Database

The following command starts a session in the mysql container:

./vendor/bin/sail mysql

The database may be cleared using:

./vendor/bin/sail artisan db:clear

Users

When using the fake data generated by artisan db:seed, all users uses the password default. One admin is choosen at random among them, so the get the email of the admin user run the following SQL statements:

USE `jobboard`;
SELECT `email` FROM `users` WHERE `is_admin` = 1;

License

The MIT License (MIT)

Copyright © 2022 Melvin Courjaud, Yanis Guaye

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.