Skip to content

Commit

Permalink
Updated README.md πŸ’…
Browse files Browse the repository at this point in the history
  • Loading branch information
LuaanNguyen committed Aug 4, 2024
1 parent 682f51d commit f22505f
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 8 deletions.
59 changes: 51 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,24 @@
# thesoda.io (New 2024)
![Thesoda.io](/public/thesoda.io.png)

### The Software Developers Association
<img src='https://img.shields.io/github/license/asusoda/asu-soda-newsite?style=for-the-badge'>

This is the directory for SoDA's new React/Vite website.
# πŸš€ thesoda.io 2024

## How to run website locally
### The Software Developers Association (SoDA)

The Software Developers Association (SoDA) at Arizona State University, is a student run, free organization dedicated to serving ASU’s computer science students. SoDA is one of the largest communities of students on campus, and is the largest engineering organization. We provide opportunities to collaborate on projects outside of the classroom, learn from university and industry professionals, and prepare for a career as a software developer.

<div align="center">

**[RUN THE DEVELOPMENT](https://github.com/asusoda/asu-soda-newsite#-how-to-run-website-locally) β€’
[TECH STACK](https://github.com/asusoda/asu-soda-newsite#-tech-stack) β€’
[CONTRIBUTING](https://github.com/asusoda/asu-soda-newsite#-contributing) β€’
[SPREAD THE WORDS](https://github.com/asusoda/asu-soda-newsite#-spread-the-word) β€’
[LICENSE](https://github.com/asusoda/asu-soda-newsite#-license)**

</div>

# πŸ’» How to run website locally

The website uses npm, which manages all dependencies and has a dummy server that you can run on your local machine to view the website.

Expand All @@ -17,14 +31,43 @@ The website uses npm, which manages all dependencies and has a dummy server that

The server will refresh the page automatically when you make changes to the code!

## Making changes
# πŸ‘¨β€πŸ’» Tech stack

Here's a brief high-level overview of the tech stack the `thesoda.io` uses:

- This project uses the [React Lirary](https://react.dev/). React is a JavaScript library for building user interfaces, particularly single-page applications where you need a fast, interactive experience.
- For build tool, [Vite](https://vitejs.dev/guide/) provides a fast development experience for web projects. When you use Vite with React, you get a development setup that is both fast and modern. Vite is configured to handle React’s specific needs efficiently, allowing you to focus more on development and less on configuration.
- [TypeScript](https://www.typescriptlang.org/) TypeScript is a superset of JavaScript that adds static typing to the language. It helps the project catch errors early in the development process and provides better tooling and code quality.
- The app is styled using [TailwindCSS](https://tailwindcss.com/) Tailwind CSS is a utility-first CSS framework designed to make it easy to build custom, responsive designs without writing custom CSS.
- Additionally, the use of external UI libraries such as [SemanticUI](https://semantic-ui.com/) and [AceternityUI](https://ui.aceternity.com/) enhances the experiences of our website. These might be subject to change later due to performance and SEO.

# 🏠 Contributing

Always make sure you pull the latest version before working on the repository. Since the website is a latest React application, uses many dependencies, and is written in ES6, you will have to use many tools to transpile the code.
Interested in contributing to the `thesoda.io`? Thanks so much for your interest! We are always looking for improvements to the project and contributions from open-source developers are greatly appreciated.

### Styling the App
Please consult to our main developer [Luan Nguyen](https://github.com/LuaanNguyen) if you have a contribution in mind. We will be publishing a [Contribution Guide](https://github.com/asusoda/asu-soda-newsite) for more information on how to do so.

## Contributors
## πŸ’™ Thank you to our current/ past contributors

<a href="https://github.com/asusoda/asu-soda-newsite/graphs/contributors">
<img src="https://contrib.rocks/image?repo=asusoda/asu-soda-newsite" />
</a>

<br><br/>

# πŸ“£ Spread the words!

If you want to say thank you and/or support active development of `thesoda.io`:

- Add a GitHub Star to the project!
- Share/ Tag [@soda.asu](https://www.instagram.com/soda.asu/) on your instagram!
- Check out our [Discord](https://discord.com/invite/EsVNGqSd3Y) server.
- Join our [Weekly Meeting](https://asu.campuslabs.com/engage/organization/soda)

# πŸͺͺ License

`Thesoda.io` is licensed under MIT License. All development is currently maintain by [Luan Nguyen](https://github.com/LuaanNguyen).

# πŸ₯€ Message from our Team

Reminder that _you are great, you are enough, and your presence is valued._ If you are struggling with your mental health, please reach out to someone you love and consult a professional. [There are many resources for you to get help in a time of need.](https://www.nimh.nih.gov/health/find-help)
Binary file added public/thesoda.io.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit f22505f

Please sign in to comment.