UC OSPO Education Lesson & Pathways Website

Work regarding the education subgroup. This repository hosts the Astro-based website for the UC OSPO Education Lesson & Pathways.

• Draft inventory of lessons - lessons pulled from existing Carpentries & Code Refinery.
• Process we are following - these are converted to issues in the GH project.
• Meeting notes

✨ Features

[TODO: Describe the awesome things your project can do! List key features from the README Guide template.]

• Feature 1 (e.g., Explore lessons by category)
• Feature 2 (e.g., Filterable lesson library)
• Feature 3 (e.g., Responsive design)

🚀 Getting Started

This project was built with Astro.

Prerequisites

[TODO: What other software would a user need to have installed? Any specific concepts to be familiar with?]

• Node.js (version 18 or higher)
• npm (Node Package Manager)

Installation

How can users install your software?

1. Clone the project:

   git clone https://github.com/UC-OSPO-Network/education.git

2. Go to the project directory:

   cd education

3. Install dependencies:

   npm install

Running Tests (Optional)

[TODO: If your project has tests, provide instructions on how to run them here.]

# Example: npm test

Run Locally

To run the project locally in development mode:

npm run dev

This will start a local development server, usually at http://localhost:4321.

Deployment

This project is configured for deployment to GitHub Pages via GitHub Actions.

📝 Usage

[TODO: Document how to use your project. Include screenshots, code samples, or links to other resources as needed.]

🗺️ Roadmap (Optional)

[TODO: Outline the future plans for this project. What's in the backlog, what's next? Refer to the Roadmap section in the README Guide.]

• Research user needs for new product features
• Develop initial product requirements document

Community & Contributing

We welcome contributions! Please see our guides below:

• Contributing Guide: How to get started with contributing to this project.
• Code of Conduct: Expectations for behavior within our community.
• Code of Conduct Guide: A guide for understanding and adapting our Code of Conduct.
• License: Project licensing information.
• Contributing Guide (Template Guide): A guide for understanding and adapting our Contributing Guide.
• License Guide: A guide for understanding and choosing a license.
• README Guide: A guide for writing a great README.

❓ FAQ (Optional)

[TODO: Add frequently asked questions and their answers here.]

📞 Contact (Optional)

[TODO: How should users contact you with questions about the project?]

• Email: [your-email@example.com]
• GitHub Issues: [https://github.com/UC-OSPO-Network/education/issues]

🙏 Attribution (Optional)

[TODO: Mention useful resources and libraries that you've leaned on in building your project.]

👀 Want to learn more about Astro?

Feel free to check our documentation or jump into our Discord server.