Adventure

Abstract

1. Introduction

The roadmap is available in the issues. Pull requests are encouraged!

The GitHub wiki also contains documentation on configuration options and database structure.

2. Objective

WinWorld's open library management system

This project demonstrates how JavaScript can be applied to a real-world Full Stack Web Development problem.

4. Technology Stack

5. System Requirements

General requirements for this technology stack — check the README for exact versions.

• Node.js (LTS) and npm
• A modern web browser
• VS Code or any code editor
• Git (to clone the repository)

6. Installation & Setup

git clone https://github.com/WinWorldPC/adventure.git
cd adventure

1. Ensure you have the dependencies - this is node.js and MariaDB.
2. Pull the repo somewhere.
3. npm install
4. Copy config.example.json to somewhere and edit it to match your
5. Run deploy/install.sql to create the tables and an admin user; this will be
6. Start adventure; the only and required command-line parameter is the path to
7. It is required that you also set up a timer or cron job to run gc.js to
8. It is also recommended that you put Adventure behind a reverse proxy, such as

Full setup instructions are in the project README.

7. Future Enhancements

Suggested extensions you can add to make this your own project.

• Add role-based access control
• Deploy on a VPS or cPanel hosting with a custom domain
• Add automated tests and a CI pipeline

8. Viva / Review Questions

Common questions examiners ask for projects in this domain.

1. Explain the frontend, backend and database layers of this application.
2. How is user authentication and authorisation implemented?
3. Describe the main database tables / collections and their relationships.
4. Which REST APIs or routes are exposed and what do they return?
5. How would you deploy this application to production?

9. Source Code & License

This project is developed by WinWorldPC and published on GitHub under the GNU Affero General Public License v3.0. Please follow the license terms and credit the original author when you use or modify this code.