Skip to content

Latest commit

 

History

History
83 lines (62 loc) · 4.56 KB

README.md

File metadata and controls

83 lines (62 loc) · 4.56 KB
Raw

Infinity Next is an imageboard using the Laravel Framework. It was conceived as a way to replace what 8chan runs on. Its current codebase has aged poorly and I felt the world was ready for a redo.

Submitting Issues

If you are submitting an issue to developers, please supply the following:

  • A concise description of your problem.
  • An exact case of the error. If the problem is code related, reference the file and line number.
  • Additional details of articles if applicable.

Please don't assume we'll understand exactly what you're talking about. If I can read an error, copy+paste something, or upload a file and reproduce an error in 30 seconds after opening your message, I can fix it without having to ask you for more information. If you do not provide an error case or details on how to recreate what you're experiencing, the first response to your issue will be "please provide an example".

Requirements

Larachan runs on Laravel 5 and has the same requirements.

  • PHP 5.5.9 or greater.
    • php5-mcrypt for bcrypt functions.
    • php5-curl for Stripe.
    • php5-gd for captcha codes and other image manipulation.

When installing from source,

  • composer

Installation

Infinity Next is currently below its first release version. When it is finished, a compiled archive will be available with an installation process. Right now, however, you must build it yourself and have access to a command line interface.

  1. Pull the code and navigate to the directory where the .env file is.
  2. Edit the .env to your liking. This is where you enter database details.
  3. Issue the command composer update and wait as 3rd party libraries are added.
  4. Issue the command php artisan migrate or ./artisan migrate
  5. Issue the command php artisan db:seed or ./artisan db:seed
    • Take note of the Admin account password that will be created for you.
  6. Optionally, if you would like CRON services for content pruning, add the Laravel CRON service provided in crontab.txt
  7. Restart your PHP daemon, using a command such as service apache2 restart or service php5-fpm restart.

You should now have a /test/ board. The admin account will be named Admin.

License

Infinity Next is distributed under the AGPL 3.0.

In short:

  • You may use Infinity Next for any reason you please.
  • You may modify Infinity Next as you see fit.
  • You may profit with Infinity Next.

However, you also agree that:

  • Infinity Next & Contributors are not liable for this software and any damage it may do.
  • Infinity Next & Contributors are not liable if this software is used to break the law.
  • You will not sell copies or modifications of this source code (no sublicensing).
  • You must distribute the source code for any publicly hosted modifications of Infinity Next under the AGPL 3.0 license in a conventional format.

The AGPL3 license is designed to protect the end user by keeping modified copies of the source open and free.

While not binding, I do ask that users link back to this git repository or to https://infinitydev.org on their website. Sharing is caring. ♥

Contributing

Everyone is welcome to contribute, but please follow repository etiquette.

  • Fork the repository.
  • Raise a separate issue for everything you intend to fix.
  • Plan your fix and allow for discussion.
  • Tie your commits to issues.
  • Keep pull requests concise, list issues addressed, and make it easy to pull them.

It would benefit you to make sure your solution has the OK before writing any code.

Coding Standards

In the name of preventing conflict and keeping the codebase clean, I am implementing the exact same standards of Laravel contributors.

Laravel follows the PSR-0 and PSR-1 coding standards. In addition to these standards, the following coding standards should be followed:

  • The class namespace declaration must be on the same line as <?php.
  • A class's opening { must be on the same line as the class name.
  • Functions and control structures must use Allman style braces. Indent with tabs, align with spaces.

"Allman style braces" refer to having a curly-brace on a new line at the same level of indentation as the conditional itself.

if (condition)
{
	// Code here.
}