This project is a RestFul interface of the lantern application.
- Fork the repo by visiting this link or clicking on the Fork button at the top right corner
- Go to your Terminal(Linux and Mac users), Git Bash(Windows), Termux(Android) and
cd
to the directory you'd like to work from. If you're using Termux, dotermux-setup-storage
and thencd storage/downloads
and work from there. - Run
git clone https://github.com/blackalbino01/Lantern_APIs
to clone the repo on your machine. - Run
cd Lantern_APIs
to enter into the cloned repo. - Run
git remote add upstream https://github.com/blackalbino01/Lantern_APIs
to create an alias for the repository - Go to your forked repository, there is a clone or download button, click on it and copy the url displayed.
- Go back to your terminal and add an alias for your repo by running
git remote add task <paste the url here>
, without the angled brackets. You can replace task with an alias of your choice, just make sure you remember it. - Run
git checkout master
to ensure you're in the correct branch. - Make your changes to the file, make your contributions and smile a lot while doing that. We don't want angry code in the repo.
- Run
git add .
to stage all your changes to be committed. Do not spill anything on your PC at this point. - Run
git commit -m "<your username>:<Feature>: <Your commit message>"
- Run
git pull --rebase upstream master
to apply possible changes that might have happened on the online repo while you were making your own changes. - Run
git push task master
. Remember to replace the alias if you changed it. - Visit the URL of your forked repo. You'll see a button Compare and pull request. Click on it, type the appropriate messages and then make the pull request.
- Take a nap, you earned it no matter how little your change.
- Ensure you do not edit the .gitignore file for any reason.
- Whatever extension to the User model is done through a database relationship and not by OOP inheritance.
- Ensure code works before pushing. Don't push breaking code.
- Proceed to the Laravel project directory by:
cd Laravel_APIs
- Run
composer install
to install composer dependencies. - Run
npm install
to install npm dependencies. - Run
cp .env.example .env
to create a copy of your .env file. - Run
php artisan key:generate
to generate an app encyrption key. - Run
php artisan serve
orphp -S localhost:8000 -t public/
to run the development server.