jr-cologne/login-script

A simple object-oriented and database-based login script with PHP.

Maintainers

Details

github.com/jr-cologne/login-script

Homepage

Source

Issues

Documentation

Installs: 10

Dependents: 0

Suggesters: 0

Security: 0

Stars: 2

Watchers: 2

Forks: 0

Open Issues: 2

Type:project

2.1.0 2018-09-01 09:28 UTC

Requires

MIT 3c9b3bdbff0183ae2f727a777f688e4ae3c415c1

phpOOPobject-orienteddatabase-based

This package is auto-updated.

Last update: 2024-04-20 23:07:42 UTC

README

A simple object-oriented and database-based login script with PHP.

Requirements/Dependencies

Installation

Using Composer (recommended)

Using Composer is the quickest way to install everything. For this, make sure you have Composer installed.

Now, in order to run the login-script on your local machine or your own server, follow these installation instructions:

First of all, execute this command in your terminal or command prompt:

composer create-project jr-cologne/login-script your-project-name

Do not forget to change your-project-name to your specific name for your project folder.

The command composer create-project is basically the same as doing a git clone followed by a composer install.

This means that you are almost finished already. Executing the one command above should have downloaded the entire project and installed all Composer dependencies as well.

Now, just continue with the Installation of Dependencies, but keep in mind that you can skip the part with Composer. Just move on to npm.

Manual Installation

In order to run the login-script on your local machine or your own server, follow these installation instructions:

  1. Download one of the archive files from the latest (stable) release of this project, either zip or tar.gz.
  2. Unpack the archive of your choice and put the files into a folder where you project should be located.
  3. Install dependencies, see Installation of Dependencies for more details.

Installation of Dependencies

You have got two options to install all dependencies for this project:

Using Composer & npm (recommended)

First of all, make sure you have Composer installed. Then execute this command in your terminal or command prompt:

composer install

This should install all dependencies listed in the file composer.json.

Secondly, you also need to have Node.js and npm installed on your computer.

Then, go ahead and run the following command:

npm install

Manual Installation

The second option to install all dependencies is just doing it manually.

For this, download all dependencies from their repositories linked above and organize them into some kind of "vendor" folder.

Then, open up the file app/init.php and replace the line regarding the Composer autoloader with the various includes for all dependencies.

Getting Started

Before following this short Getting Started Guide, please ensure that you have successfully installed everything outlined in the above Installation Guide.

In order to achieve getting the login-script working as expected, you need to do the following things:

  • Set up your database and the connection to it
  • Set up your access to the API of Google and Twitter for the Social Authentication feature as well as Bugsnag for Error Handling
  • Set up the connection to an SMTP server for Email Delivery
  • Deploy!

Let's get started!

Database Setup

If you take a look in the database folder, you can see that the login-script provides you with a SQL file (db-setup.sql) for setting up your database. Just load this into your database client and everything should be fine.

After you have successfully set up the database, you only need to establish your database connection.

For this, copy the file .env.example and rename it to .env.

For now, you just need to worry about changing the following settings inside the environment variables file:

DATABASE_TYPE=mysql
DATABASE_NAME=login-script
DATABASE_HOST=127.0.0.1
DATABASE_USER=user
DATABASE_PASSWORD=password

That's it. Your database should now be ready to go.

Setting up Access to APIs for Social Auth and Error Handling

As I already mentioned shortly, you need access to a total of three APIs in order to make everything work properly without really touching any code.

These are the three APIs/Services of interest:

Let's start setting them up.

Bugsnag

First of all, go ahead and sign up for a Bugsnag account at bugsnag.com.

After that, Bugsnag will guide you through a small setup tour for your specific project.

In the case of the login-script, you need to select a server application, the language PHP and no framework (other) when you are asked for this kind of information.

Once you successfully set up your project, a quick installation guide is shown. In there, you can also find your API key. In our case, you can find this API key inside the line of code which basically looks like that:

$bugsnag = Bugsnag\Client::make('your-api-key');

Now, just copy that API key. In case you are not working with environment variables to store secret information like API credentials, the login-script supports grabbing your API key from a JSON config file. For Bugsnag, this config file should look like this:

{
  "api_key": "your-api-key"
}

So, just paste your API key from Bugsnag in there and then save your JSON file to some directory which is ignored by git since you don't want your API keys to be publically available on GitHub or something like that.

Finally, to make sure the login-script knows where it can find your file, you need to specify the file path inside .env.

Inside the file .env, look for something looking like this and modify it for your own needs:

BUGSNAG_CONFIG_FILE=storage/error_handling/bugsnag/bugsnag-api-credentials.json

That's all. You should now be ready for handling your errors with Bugsnag.

Google Sign-In for Websites

Setting up Google Sign-In for Websites is relatively simple since Google provides you with a tone of information and an easy setup tour.

Just go to the Getting Started Guide for Google-Sign for Websites and click on the button "Configure a Project".

You are then asked to enter a project and a product name. Next, you need to configure your OAuth client.

For your application environment, choose "Web Server". Furthermore, your authorized Redirect URIs need to look similar to this:

http://example.com/google_login.php
http://example.com/google_register.php

For Localhost:
http://localhost/google_login.php
http://localhost/google_register.php

Very important is that the filenames stay the same. The rest can be adapted.

Next, download the client configuration of your created project. This is a JSON file which can be used for the login-script to define your credentials for the Google API. For this, again just use a directory which is ignored by git and make sure you put the file path inside the .env file of the login-script. This is the setting you need to change:

GOOGLE_CONFIG_FILE=storage/social_auth/google/xxx.apps.googleusercontent.com.json
GOOGLE_REDIRECT_URI_LOGIN=http://example.com/google_login.php
GOOGLE_REDIRECT_URI_REGISTER=http://example.com/google_register.php

The path to your Google client configuration file needs to be specified at GOOGLE_CONFIG_FILE. In addition, go ahead and change the redirect URIs as well. The rest can stay the same.

That's it. You can now move on to Twitter.

Twitter API

Setting up everything for accessing the Twitter API is a bit more complex compared to Google.

First of all, you need to create a Twitter App over at apps.twitter.com. In order to be able to do this, you might need to apply for a Twitter developer account.

During this process, you are asked for a project name, a description, the website of your application and a Callback URL.

This is basically the same as the Redirect URI what Google calls it. Again, this needs to look similar to this:

http://example.com/twitter_login.php
http://example.com/twitter_register.php

For Localhost:
http://localhost/twitter_login.php
http://localhost/twitter_register.php

Like already mentioned, it is especially important that the filename stays the same. The rest can be edited.

Once you then successfully created your app, you need to change the following settings for your Twitter App:

  • Go to the settings page and activate the checkbox "Allow this application to be used to Sign in with Twitter".
  • Go to the permissions page. Under "Additional Permissions", activate the checkbox "Request email addresses from users".

Next, go to the page "Keys and Access Tokens". There you can find your API key and your API secret key.

Now, you need to copy and paste them into another JSON config file responsible for the Twitter API credentials.

Here is the required format:

{
  "api_key": "your-api-key",
  "api_secret": "your-api-secret-key"
}

Save this file including your credentials inside a folder which is ignored by git and specify the file path inside the file .env.

TWITTER_CONFIG_FILE=storage/social_auth/twitter/twitter-api-credentials.json
TWITTER_REDIRECT_URI_LOGIN=http://example.com/twitter_login.php
TWITTER_REDIRECT_URI_REGISTER=http://example.com/twitter_register.php

Like with Google, you need to change the TWITTER_CONFIG_FILE option as well as the Redirect URIs.

That's all. You should now have access to the Twitter API.

Setting up Email Delivery through an SMTP server

Finally, let's set up email delivery by configuring the login-script to use an SMTP server for this.

If you don't have an SMTP server, you might be interested in using Gmail's SMTP server.

Once you have the credentials to some kind of SMTP server, go ahead and create another JSON config file inside a directory which is ignored by git. The format of your JSON file is as follows:

{
  "smtp_server": "your-smtp-server-address",
  "smtp_port": "your-smtp-port",
  "smtp_encryption": "tls",
  "smtp_username": "your-smtp-username",
  "smtp_password": "your-smtp-password"
}

After entering your credentials, save the JSON file and then open up the .env file of the login-script.

Now, search for this entry:

SMTP_CONFIG_FILE=storage/mail/smtp/smtp-server-credentials.json

Everything you need to specify is the file path to your file containing the SMTP server credentials.

After doing all of this, everything should be ready to go. Go ahead, deploy your application and have fun! If you want to, you can, of course, customize the login-script according to your own needs.

Contributing

Feel free to contribute to this project! Any kinds of contributions are highly appreciated!

License

This project is licensed under the MIT License.