Skip to content

developer_documentation.md

Latest commit

 

History

History
40 lines (25 loc) · 1.28 KB

developer_documentation.md

File metadata and controls

40 lines (25 loc) · 1.28 KB
Raw

Developer guidelines

Obtain the source code

  1. Ensure you have Git installed on your system.

  2. Clone the repository using the following command: cd git@github.com:LucyCheng111/Dam-Lore.git

  3. Navigate to the project directory: cd Dam-Lore

Layout of your directory structure

The overview of the project is in README.md. Weekly status reports can be found in the reports/ directory. Photos storage and CSS style sheets are in the static/ directory. User guidelines can be found in user_guideline.md All index files that build up the pages are in the main directory.

Build the software

This is a web-based application, no complex build system is required. To run the project:

  1. Ensure you have a local web server (or use Live Server in VS Code for testing).

  2. Open index.html in a web browser to view the application.

Test the software

Navigate through the website and ensure all pages, links, and interactive elements work as expected.

Add new tests.

Place new test files inside the tests/ directory. Follow the naming convention: name_test.js.

Build a release of the software

  1. Update the version number in README.md and any version-tracking files.

  2. Ensure all tests pass before building a release.