An awesome application to bring your favourite sites together in one place.
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
Table of Contents
Lumic is a lightweight web application designed to bring your favourite sites together. You can create your own dashboard and access all your applications in one click.
This application works like a link reducer. You can associate a name to your application link, and access it directly through your custom URL (e.g. https://www.youtube.com/watch?v=dQw4w9WgXcQ -> lumic.fr/yt)
Designed to be used by teams and organisations, you can also share your links with other members of your team or publish them to the world.
In the future, this application will allow for other advanced features such as tracking link activity or using temporary links.
This section should list any major frameworks that you built your project using. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.
This application is based on the Laravel framework and VueJS. All instructions for installing and developing a Laravel application are also valid.
Before clonning the repository, you must have an apache web server, and a database installed on your computer. You can use WampServer, XAMPP or any other web development bundle. Then you should install and update npm to the latest available version.
- npm
npm install npm@latest -g
We strongly encourage you to use Composer to install the Laravel application.
- Clone the repo in your Apache web server
git clone https://github.com/killian-mahe/lumic.git
- Install Composer packages
composer install
- Install NPM packages
npm install
- Copy the
.env.exampleto.envand complete the variablesAPP_NAME=Lumic APP_ENV=local APP_KEY= APP_DEBUG=true APP_URL=http://localhost LOG_CHANNEL=stack LOG_LEVEL=debug DB_CONNECTION=mysql DB_HOST=127.0.0.1 DB_PORT=3306 DB_DATABASE=lumic DB_USERNAME=my_username DB_PASSWORD=my_password BROADCAST_DRIVER=log CACHE_DRIVER=file QUEUE_CONNECTION=sync SESSION_DRIVER=database SESSION_LIFETIME=120 MEMCACHED_HOST=127.0.0.1 REDIS_HOST=127.0.0.1 REDIS_PASSWORD=null REDIS_PORT=6379 MAIL_MAILER=smtp MAIL_HOST=mailhog MAIL_PORT=1025 MAIL_USERNAME=null MAIL_PASSWORD=null MAIL_ENCRYPTION=null MAIL_FROM_ADDRESS=null MAIL_FROM_NAME="${APP_NAME}" AWS_ACCESS_KEY_ID= AWS_SECRET_ACCESS_KEY= AWS_DEFAULT_REGION=us-east-1 AWS_BUCKET= PUSHER_APP_ID= PUSHER_APP_KEY= PUSHER_APP_SECRET= PUSHER_APP_CLUSTER=mt1 MIX_PUSHER_APP_KEY="${PUSHER_APP_KEY}" MIX_PUSHER_APP_CLUSTER="${PUSHER_APP_CLUSTER}"
- Start the build watcher
npm run watch
- (optional) Start the Laravel built-in server
php artisan serve
- Before each commit or push, make a complete build using :
npm run build
See the open issues for a list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the MIT License. See LICENSE for more information.
Killian Mahé - @killian-mahe - killianmahe.pro@gmail.com
Project Link: https://github.com/killian-mahe/lumic