Skip to content

taraliu23/AroAndSword

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

56 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Project Logo

AROANDSWORD

license last-commit repo-top-language repo-language-count


Table of Contents


Overview

I developed aro-n-sword.com, an open-sourced, full-stack web application focused on increasing visibility and understanding of aromanticism in the LGBTQIA+ community. The project arose from identifying a critical need: aromantic individuals, who make up just 0.4% of the population, lacked engaging online resources and often face AI-driven discrimination in content moderation.

As the sole developer, I built an interactive platform featuring educational resources and community-building elements like a Bingo game. This first-of-its-kind website has created an accessible space for learning about aromantic experiences while fostering community engagement through its dynamic content.


Features

  • Interactive Education widget on LGBTQIA+

  • 2 Bingo games! (You can share results with friends)

  • Stress-relieving meditation page with floating cards

  • Most helpful Resource list for the aromantic


Project Structure

└── AroAndSword/
	├── LICENSE
	├── SECURITY.md
	└── aro-and-sword
		├── .gitignore
		├── README.md
		├── jsconfig.json
		├── next.config.mjs
		├── package-lock.json
		├── package.json
		├── postcss.config.mjs
		├── public
		├── src
		├── tailwind.config.js
		└── tsconfig.json

Project Index

AROANDSWORD/
__root__
⦿ __root__
File Name Summary
LICENSE Code>❯ REPLACE-ME
aro-and-sword
⦿ aro-and-sword
File Name Summary
jsconfig.json Code>❯ REPLACE-ME
tailwind.config.js Code>❯ REPLACE-ME
postcss.config.mjs Code>❯ REPLACE-ME
next.config.mjs Code>❯ REPLACE-ME
package-lock.json Code>❯ REPLACE-ME
package.json Code>❯ REPLACE-ME
tsconfig.json Code>❯ REPLACE-ME
src
⦿ aro-and-sword.src
app
⦿ aro-and-sword.src.app
File Name Summary
layout.js Code>❯ REPLACE-ME
page.js Code>❯ REPLACE-ME
index.js Code>❯ REPLACE-ME
globals.css Code>❯ REPLACE-ME
resources
⦿ aro-and-sword.src.app.resources
File Name Summary
page.js Code>❯ REPLACE-ME
components
⦿ aro-and-sword.src.app.components
File Name Summary
LGBTQIAExplanation.jsx Code>❯ REPLACE-ME
ManifestoSection.jsx Code>❯ REPLACE-ME
Navbar.js Code>❯ REPLACE-ME
InfoSection.js Code>❯ REPLACE-ME
Header.js Code>❯ REPLACE-ME
PostItCard.jsx Code>❯ REPLACE-ME
TypewriterHero.js Code>❯ REPLACE-ME
Resources.js Code>❯ REPLACE-ME
Bingo.js Code>❯ REPLACE-ME
Footer.js Code>❯ REPLACE-ME
HeroSection.js Code>❯ REPLACE-ME
manifesto
⦿ aro-and-sword.src.app.manifesto
File Name Summary
page.js Code>❯ REPLACE-ME
pages
⦿ aro-and-sword.src.app.pages
File Name Summary
what-is-aromanticism.js Code>❯ REPLACE-ME
sam-model.js Code>❯ REPLACE-ME
bingo
⦿ aro-and-sword.src.app.bingo
File Name Summary
page.js Code>❯ REPLACE-ME

Getting Started

Prerequisites

This project requires the following dependencies:

  • Programming Language: JavaScript
  • Package Manager: Npm

Installation

Build AroAndSword from the source and intsall dependencies:

  1. Clone the repository:

    ❯ git clone https://github.com/taraliu23/AroAndSword
  2. Navigate to the project directory:

    cd AroAndSword
  3. Install the dependencies:

<!-- [![npm][npm-shield]][npm-link] -->
<!-- REFERENCE LINKS -->
<!-- [npm-shield]: https://img.shields.io/badge/npm-CB3837.svg?style={badge_style}&logo=npm&logoColor=white -->
<!-- [npm-link]: https://www.npmjs.com/ -->

**Using [npm](https://www.npmjs.com/):**

```sh
❯ npm install
```

Usage

Run the project with:

Using npm:

npm start

Testing

Aroandsword uses the {test_framework} test framework. Run the test suite with:

Using npm:

npm test

Roadmap

  • Task 1: Implement feature one.
  • Task 2: Implement feature two.
  • Task 3: Implement feature three.

Contributing

Contributing Guidelines
  1. Fork the Repository: Start by forking the project repository to your github account.
  2. Clone Locally: Clone the forked repository to your local machine using a git client.
    git clone https://github.com/taraliu23/AroAndSword
  3. Create a New Branch: Always work on a new branch, giving it a descriptive name.
    git checkout -b new-feature-x
  4. Make Your Changes: Develop and test your changes locally.
  5. Commit Your Changes: Commit with a clear message describing your updates.
    git commit -m 'Implemented new feature x.'
  6. Push to github: Push the changes to your forked repository.
    git push origin new-feature-x
  7. Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.
  8. Review: Once your PR is reviewed and approved, it will be merged into the main branch. Congratulations on your contribution!
Contributor Graph


License

Aroandsword is protected under the LICENSE License. For more details, refer to the LICENSE file.


Acknowledgments

  • Credit contributors, inspiration, references, etc.


Releases

No releases published

Packages

No packages published