search

RedbeardTFL / ATIS_GENERATOR

Other
0 stars 0 forks source link

readme

ATIS GENERATOR

License: CC BY-NC-SA 4.0 Contributors Issues Forks Build Status Laravel Forge Site Deployment Status

Getting Started

  1. Clone the repo

    git clone https://github.com/RedbeardTFL/ATIS_GENERATOR.git && cd ATIS_GENERATOR/src

  2. Install Composer dependencies

    composer install

  3. Fill in the .env file with your database credentials

    cp .env.example .env

  4. Run artisan commands to generate a key and migrate the database

    php artisan key:generate & php artisan migrate --seed

  5. Run git command to generate a version file for the footer

    git describe --always --tags --dirty > version

  6. Run the development server

    php artisan serve

Docker

  1. Pull the image

    docker pull insidiousfiddler/redbeards-atis-generator

  2. Run the container with your database credentials

    docker run -d -p 8000:80 insidiousfiddler/redbeards-atis-generator -e DB_HOST=<host> -e DB_PORT=<port> -e DB_DATABASE=<database> -e DB_USERNAME=<username> -e DB_PASSWORD=<password>

  3. Visit the site at http://127.0.0.1:8000

Requirements

  1. PHP: version 8.1 or greater
  2. MYSQL: My current server setup is running 10.3.36-MariaDB-log-cll-lve
  3. cURL: is used to fetch weather info, so this function must be enabled.
  4. Composer: is used to install dependencies

Roadmap

Upcoming Features and Improvements

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the CC BY-NC-SA 4.0 License. See LICENSE for more information. The CC BY-NC-SA 4.0 License overrides the included LICENSE file. The LICENSE file included is a secondary license that also applies to this project and is included for reference.

Contributors