django-fest-offical

Website built for the Django Fest KC event. Made by Liz Wait

Table of Contents

• Installation
• Usage
• Contributing
• License

Installation

Prerequisites

• Node.js (https://nodejs.org/)
• npm (Node Package Manager, comes with Node.js)

Steps

1. Clone the repository:

   git clone [email protected]:KansasCityWomeninTechnology/django-fest-official.git

2. Change directories to project:

   cd django-fest-official

Usage

Running the Project

1. Start a local server:

   node server.js

2. Open your browser and navigate to:

   http://localhost:8080/
   

File Structure

• src/index.html: The main HTML file.
• src/styles.css: The main CSS file.
• src/script.js: The main JavaScript file.
• src/sections/: Directory containing HTML files for each section.

Adding New Sections

1. Create a new HTML file in the sections directory.
2. Add a new entry to the getSections function in script.js with the appropriate id and file path.

Contributing

1. Fork the repository.
2. Create a new branch (git checkout -b feature-branch).
3. Make your changes.
4. Build the site locally to ensure your changes worked and did not produce any bugs.
5. Commit your changes (git commit -m 'Add some feature').
6. Push to the branch (git push origin feature-branch).
7. Open a pull request.
   • Your pull request will need to be approved by another contributor.

Deployment

1. Create PR for your updates.
2. Once PR has been approved by another reviewer, merge your PR to master.
3. Github Actions will auto deploy changes if merged to master branch.

License

This project is licensed under the MIT License - see the LICENSE file for details.