This is a repository for the Swiftqueue Courses API made entirely in vanilla PHP. It is a RESTful API that allows you to create, read, update and delete courses. It also allows you to register and login users.
To run the API, you need to have the following technologies installed:
Or you can use MAMP or XAMPP to install all of the above.
To install the courses, you need to have Git installed. Then, run the following command in your terminal:
git clone https://github.com/thewebsitedev/swiftqueue-courses.gitYou need to have some sort of server environment to run the courses. You can use MAMP or XAMPP for this. If you are using MAMP, you need to put the courses in the htdocs folder. If you are using XAMPP, you need to put the courses in the htdocs folder.
Make sure you have Composer installed. Then, run the following command in your terminal:
composer require vlucas/phpdotenvThen, run the following command in your terminal:
composer dump-autoloadAlso make sure to update the environment variables in the .env file according to your setup.
To use the courses api, you need to have a browser installed. You can use Google Chrome or Mozilla Firefox. Then, open the browser and go to http://localhost:8888/swiftqueue-test/api/courses/. You should see a list of the courses. Click on the course you want to view and you will be taken to the course page.
List of API urls:
| API URLs | Available Methods |
|---|---|
| http://localhost:8888/swiftqueue-test/api/courses/ | GET, POST, PUT, DELETE |
| http://localhost:8888/swiftqueue-test/api/users/ | POST |
Getting a list of courses:
curl http://localhost:8888/swiftqueue-test/api/courses/Getting a single course:
curl http://localhost:8888/swiftqueue-test/api/courses/index.php?id=1Creating a course:
curl -X POST -H "Content-Type: application/json" -d '{"name":"Test Course","start_date":"2024-01-01T00:00","end_date":"2024-01-01T00:00",status:"active"}' http://localhost:8888/swiftqueue-test/api/courses/index.phpDeleting a course:
curl -X DELETE http://localhost:8888/swiftqueue-test/api/courses/index.php?id=1Updating a course:
curl -X PUT -H "Content-Type: application/json" -d '{"id":1,"name":"Test Course","start_date":"2024-01-01T00:00","end_date":"2024-01-01T00:00",status:"active"}' http://localhost:8888/swiftqueue-test/api/courses/index.phpUser login:
curl -X POST -H "Content-Type: application/json" -d '{"login":true,"email":"xyz@abc.com","password":"123456"}' http://localhost:8888/swiftqueue-test/api/users/index.phpUser registration:
curl -X POST -H "Content-Type: application/json" -d '{"register":true,"email":"","password":"","first_name":"","last_name":"","role":""}' http://localhost:8888/swiftqueue-test/api/users/index.phpPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.