Final Year University Project at Aberystwyth University
/components - Re-usable React Components developed for use throughout website.
/db - Database setup files. Contains docker-compose.yml that can be used to spin up a MariaDB instance using Docker. Initialisation SQL found in /db/sql
/documents - Documents supporting the written report
/hooks - Custom React hooks written
/lib - Contains functions that interact with extenal services.
/mock-sms - Web application for mocking SMS messages
/pages - Page view files.
/pages/api - API endpoint handlers
- MariaDB (Version >10.6) (Docker-compose setup file provided) https://mariadb.org/
- Node.js (>12.7.0) and NPM (>v8.5.0) https://nodejs.org/en/
- Docker, if using the provided docker-compose file to run database https://www.docker.com/
- Clone Repo
npm install- Copy
template.envto.envand populate with environment variables - If not using the Docker setup, run the
db/init.sqlfile on your MariaDB server to create required tables.
- If using the Docker DB setup:
cd db/, thendocker-compose up -d cd .., thennpm run dev
The mock SMS application is located in the mock-sms/ directory. This is for testing the SMS system without having real mobile numbers to send to. In reality, the calls to this API should be replaced with a service like Twilio.
To setup:
cd mock-smsnpm install- Copy the DB config from this projects .env file into an .env file inside
mock-sms/. Change DB_DATABASE variable tomock-sms. - Configure this projects .env to point to the right url and port for the mock service.
- Run mock-sms/db/init.sql on your MariaDB instance to set up the required DB tables.
npm run dev
There are a few pre-set numbers o the index page, however any number can be checked by simply appending it to the base url. E.g. to check 07546 123456 for mesages, navigate to: http://localhost:3001/07546123456
Open http://localhost:3000 with your browser to see the result