Getting Started

Installation Guide

Step-by-Step Instructions on Setting Up Your Development Environment

1. Prerequisites

   • Ensure you have the latest version of Node.js and npm installed. You can download them from Node.js official website.
   • Git installed on your machine. Download Git.

2. Clone the Repository

   • Open your terminal.
   • Run git clone https://github.com/skunkworksza/skunkworks.github.io.git.
   • Navigate into the cloned directory using cd skunkworks.github.io.

3. Install Dependencies

   • Run npm install to install all required dependencies.

4. Local Development

   • Start the development server by running npm start.
   • Visit http://localhost:3000 in your web browser to see the project running.

5. Environment Setup

   • Copy the .env.example file to a new file called .env.
   • Modify the .env file with the necessary configurations specific to your development environment.

6. IDE Configuration

   • For optimal coding standards, configure your IDE with ESLint and Prettier.

7. Final Checks

   • Run npm test to ensure all tests pass.
   • Check the application logs for any errors.

Quick Start Tutorial

A Beginner-Friendly Tutorial for Your First Project Commit

1. Understanding the Repository Structure

   • Familiarize yourself with the main directories: src for source files, test for tests, and docs for documentation.

2. Make a Simple Change

   • Navigate to the src directory.
   • Open the App.js file and change the welcome message to something personal.

3. Run the Project Locally

   • Ensure your changes work by running the project with npm start.

4. Commit Your Changes

   • Run git status to see your changes.
   • Add your changes with git add src/App.js.
   • Commit your changes with git commit -m "Update welcome message".

5. Push Your Changes

   • Push your changes to GitHub with git push.

6. Creating a Pull Request

   • Go to the GitHub repository.
   • Click on 'New Pull Request'.
   • Select your branch and describe your changes.
   • Submit the pull request.

FAQs

Answers to Frequently Asked Questions by New Users

1. How do I reset my password?

   • Go to the login page and click on "Forgot Password?" to reset your password through the provided steps.

2. Where can I find the project's coding standards?

   • The coding standards are located in the docs/coding-standards.md file within the repository.

3. Who do I contact if I run into issues?

   • Please send an email to [email protected] or use the Issues section on GitHub.

4. Can I contribute without coding?

   • Yes! Contributions can be in the form of documentation, designs, testing, and more.

5. What is the release cycle of the project?

   • We typically release major updates every three months, with minor updates and bug fixes as needed.