https://github.com/joindin/joindin-api

The Joind.in API PHP Application
https://github.com/joindin/joindin-api

hacktoberfest

Last synced: 5 days ago
JSON representation

The Joind.in API PHP Application

• Host: GitHub
• URL: https://github.com/joindin/joindin-api
• Owner: joindin
• License: bsd-3-clause
• Created: 2013-05-03T17:44:24.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2024-05-24T17:22:11.000Z (6 months ago)
• Last Synced: 2024-08-02T12:43:44.269Z (3 months ago)
• Topics: hacktoberfest
• Language: PHP
• Homepage: http://docs.joind.in/joindin-api/
• Size: 6.66 MB
• Stars: 44
• Watchers: 14
• Forks: 169
• Open Issues: 0
• Metadata Files:
  • Readme: README-local-dev.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-starred - joindin/joindin-api - The Joind.in API PHP Application (hacktoberfest)

README

        
# Quick start with the PHP dev server

The API will run happily under the [PHP development server](http://php.net/manual/en/features.commandline.webserver.php).  You will need to have a MySQL running with the Joind.in schema availble, referenced from the src/database.php file (see below about initialising the DB).  Note that the web2 site will also run under the built-in webserver, but will need to be on a different listening port.

To run the API on http://localhost:8080/, do the following:

```

cd public

export JOINDIN_API_BASE_URL=http://localhost:8081

php -S localhost:8081 index.php

```

## Initialising the database

As you are not using the Vagrant setup, you will need to provide your own MySQL database and configure it in src/database.php.  Once there is an empty database and a username/password, you can setup the tables by running the patch script at scripts/patchdb.sh with the "-i" (initialise DB) option.

```

cd scripts

./patchdb.sh -t ../ -d  -u  -p  -i

```

If you already have a development DB, but you want to patch it up to the latest structure, then run the same command except omit the "-i" option.

```

cd scripts

./patchdb.sh -t ../ -d  -u  -p 

```