Readmarvel Save

ReadMarvel's open sourced code

Project README

License Codeship

Read Marvel

ReadMarvel.com is a fan made website. It is built entirely on Laravel 5. All data is provided by Marvel through their public Marvel API. You can see the website fully functioning here: http://readmarvel.com/ You can read more about it on their official website

Requirements

  • Nginx
  • MySQL
  • Redis server
  • Composer
  • Marvel Developer account
  • Mailgun account (or your favourite e-mail service)
  • Google ReCaptcha account
  • (optional) Google Analytics account (if you are going to use GA)
  • (optional) PhantomJS (for running the Codeception tests)

Project setup

  • Register in http://developer.marvel.com to get your API keys (you'll use it later)
  • Setup Vagrant with Homestead (https://laravel.com/docs/5.3/homestead)
  • Setup redis server on your Homestead environment
  • Create a new MySQL database in Homestead (ex. "marvel")
  • Navigate to the project root in Homestead and run composer install
  • Rename the .env.example file to .env
  • Open your .env file and replace the placeholder values with your custom values
  • Run php artisan migrate --seed
  • Pay attention to the console messages. A message with your admin user should appear in the console
  • Setup a vhost (ex. marvel.dev. This step will vary depending on your OS)
  • Open your newly setup vhost in your browser

Contributing

  • Fork the project;
  • Branch off develop;
  • Commit and push;
  • Make a PR to the original project;

License

The "ReadMarvel.com" web app is open-sourced software licensed under the MIT license;

Open Source Agenda is not affiliated with "Readmarvel" Project. README Source: ivan-atanasov/readmarvel
Stars
32
Open Issues
0
Last Commit
5 years ago

Open Source Agenda Badge

Open Source Agenda Rating