diff --git a/README.md b/README.md index baa6b3a..73fc749 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,18 @@ -# Nextra Docs +# ACM Hack Website -This is a template for creating documentation with [Nextra](https://nextra.site). +**Check it out @ [hack.acmucsd.com](https://hack.acmucsd.com)!** +Welcome to ACM Hack's main website! This website serves as an introduction to the Hack community, and provides information about our upcoming events and resources. It's also the primary host of our Hack School curriculum, which is a series of workshops designed to teach students the fundamentals of full-stack development and software engineering. -[**Live Demo (https://hack-website-acmucsd.vercel.app/)**](https://hack-website-acmucsd.vercel.app/) +The content on this website is accessible to anyone, regardless of acceptance to Hack School. Feel free to use this for ACM Projects, personal projects, or just to learn something new! -## Local Development +This project was bootstrapped with [Nextra](https://nextra.site) and deployed with [Vercel](https://vercel.com). -Prerequisites +## Contributing + +We welcome any contributions from the ACM community! If you have ideas for new content to add, feel free to contact us in the [ACM Discord](https://acmurl.com/discord) or [ACM Hack Discord](https://acmurl.com/hack-discord) by pinging the `@Hack` role, or directly opening up a pull request. If you notice any content errors or have suggestions for improvements, feel free to raise an issue on our repository. Make sure to follow the instructions below to set up your local environment for development. + +Prerequisites: - Node v16.14.0 or higher - Yarn diff --git a/pages/hack-school/index.mdx b/pages/hack-school/index.mdx index 7e16367..a30e03e 100644 --- a/pages/hack-school/index.mdx +++ b/pages/hack-school/index.mdx @@ -6,7 +6,11 @@ Hack School is a quarter-long, full-stack web development bootcamp. It's designe a web application in just 6 workshops! -## What do you learn? +## What will I learn? Our Hack School project is built with the MERN stack (MongoDB, Express.js, React.js, Node.js), which is a modern set of technologies for web development. We chose the MERN stack for its wide adoption in the development community, ease of use, and single-language knowledge (you only need to learn JavaScript)! Over the course of 6 workshops, we'll touch on concepts such as building user interfaces, server-side programming, and deploying your web application. There are absolutely no prerequisites for this course -- we've designed it so that you learn as you go through it! + +## How do I use this website? +Under the Hack School tab on the left, you'll find pages for every technology and concept we teach during Hack School, so you won't be missing out on any content. Each page has a sidebar on the right +that you can use to quickly navigate through the content. We've included code samples and links to relevant documentation to help you as you work through our material! diff --git a/pages/hack-school/logistics.mdx b/pages/hack-school/logistics.mdx index 289d891..21cb0f8 100644 --- a/pages/hack-school/logistics.mdx +++ b/pages/hack-school/logistics.mdx @@ -2,7 +2,7 @@ This page is a collection of all the logistics for Hack School. Given the popularity of Hack School, we're only able to admit so many students to attend our workshops in-person during the fall quarter. However, we record our workshops and maintain all of our material! If you aren't admitted, or you're viewing this after fall quarter, but you still want to follow -along, you can find all of our material on our GitHub, our YouTube, and this textbook! +along, you can find all of our material on our [GitHub](https://acmurl.com/hackschool-fa23), our [YouTube](https://acmurl.com/youtube), and this textbook! ## Fall Quarter 2023 Our next iteration of Hack School will be running in Fall 2023. You can find all related logistics here, including the dates & locations of our workshops, Zoom links, calendar for office hours, and necessary material. @@ -10,14 +10,14 @@ We'll make slides or other prerequisite material available before every workshop -Workshop 1: HTML/CSS +Workshop 1 (10/10): HTML/CSS -Workshop 2: JavaScript +Workshop 2 (10/18): JavaScript -Workshop 3: React.js and Building Front-End interfaces +Workshop 3 (10/25): Building Front-End Interfaces with React and Next.js -Workshop 4: Express.js and Server-Side programming +Workshop 4 (11/1): Express.js and Server-Side Programming -Workshop 5: All About Databases with MongoDB +Workshop 5 (11/8): All about Databases with MongoDB -Workshop 6: Deployment with AWS and Vercel \ No newline at end of file +Workshop 6 (11/15): Deployment with Vercel \ No newline at end of file