A simple virtual business card to improve your network and reachability.

• Virtual Card API
  • Table of content
  • Installation
    • Local
    • Sail (Docker)
  • Licence
  • Author

1. Firstly you need to install the system required packages. If you are running on a Unix system, you could run the following command to install the required packages. If you are running on a Windows system or another you could search about the dependencies separated and install each one.

chmod +x install-system-requirements.sh && sudo ./install-system-requirements.sh

2. After install the system required packages, you must run the following command to install the Laravel required packages.

composer install

3. By now your application has the necessary dependencies, but still not operating. Copy the .env.example file as .env and run the following command to generate the app key.

php artisan key:generate

4. Run the following command to run the migrations using artisan:

php artisan migrate

5. Run the following command to generate some fake data for testing purposes

php artisan db:seed

6. Finally, run the following command to serve the API

php artisan serve

1. Copy the .env.example file as .env. You could run the API using Laravel Sail. For it, just setup the following alias into your local .bashrc file:

alias sail='[ -f sail ] && sh sail || sh vendor/bin/sail'

2. Now, run the following command to up the containers

sail up -d

3. By now your application has the necessary dependencies, but still not operating. Run the following command to generate the app key.

sail artisan key:generate

4. Run the following command to run the migrations using artisan:

sail artisan migrate

5. Run the following command to generate some fake data for testing purposes

sail artisan db:seed

And then, your API will be up and running.

This project is licensed under the MIT Licence. See more information about here

• Gabriel Santos Cardoso - eng.gabrielscardoso@gmail.com

🆙 Back to top