https://github.com/t-a-g-o/filltheunitcircle
A simple website to practice filling in a unit circle
https://github.com/t-a-g-o/filltheunitcircle
css eslint js next practice webapp
Last synced: 3 months ago
JSON representation
A simple website to practice filling in a unit circle
- Host: GitHub
- URL: https://github.com/t-a-g-o/filltheunitcircle
- Owner: t-a-g-o
- License: apache-2.0
- Created: 2024-10-29T03:39:24.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-04T19:00:38.000Z (over 1 year ago)
- Last Synced: 2025-03-01T11:44:46.435Z (over 1 year ago)
- Topics: css, eslint, js, next, practice, webapp
- Language: JavaScript
- Homepage: https://unitcirclepractice.netlify.app/
- Size: 221 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Unit Circle Practice
This simple web application is to practice filling out a unit circle. You must fill the 16 common reference angles and then you can check it afterwards. Enable or disable different information ot test on and mess with different visual options. Want tips or studying the unit circle? View the reference page with a filled circle and different tips for filling one in.
## Table of Contents
- [Features](#features)
- [Getting Started](#getting-started)
- [Technologies Used](#technologies-used)
- [Scripts](#scripts)
- [Project Structure](#project-structure)
- [Contribute](#Contribute)
- [License and Contact](#license-and-contact)
## Features
- Modern React and Next.js 13 setup with App Router
- ESLint for code linting
- Tailwind CSS for styling
- Custom UI components
- Test on information you choose to test on
- View a reference of the unit circle, and tips
## Getting Started
To launch the webapp on your computer, follow these steps:
1. Clone the repository:
```
git clone https://github.com/t-a-g-o/filltheunitcircle.git
```
2. Install dependencies:
```
cd filltheunitcircle
npm install
```
3. Run the development server:
```
npm run dev
```
4. Open [http://localhost:3000](http://localhost:3000) in your browser to see the application.
## Technologies Used
## Scripts
- `npm run dev`: Runs the development server
- `npm run build`: Builds the application for production
- `npm start`: Starts the production server
- `npm run lint`: Runs ESLint to check for code issues
## Project Structure
The project follows a Next.js 13 structure with the app router:
```
filltheunitcircle/
├── tailwind.config.js
├── next.config.mjs
├── jsconfig.json
├── components.json
├── package.json
├── postcss.config.mjs
├── src/
│ ├── app/
│ │ ├── reference/
│ │ │ └── page.js
│ │ ├── favicon.ico
│ │ ├── globals.css
│ │ ├── layout.js
│ │ └── page.js
│ ├── fonts/
│ │ └── fonts...
│ ├── components/
│ │ ├── ui/
│ │ │ └── various UI components...
│ │ └── providers and wrappers...
│ ├── hooks/
│ │ └── use-toast.js
│ ├── lib/
│ │ └── utils.js
├── .eslintrc.json
├── .gitignore
├── next
├── README.md
└── LICENSE
```
## Contribute
Contributions to the practice app are welcome and appreciated! If you'd like to contribute, here's how you can get started:
1. Fork the repository on GitHub.
2. Clone your forked repository to your local machine.
3. Create a new branch for your feature or bug fix.
4. Make your changes and commit them with clear, descriptive commit messages.
5. Push your changes to your fork on GitHub.
6. Open a pull request from your fork to the main repository.
When submitting a pull request:
- Clearly describe the problem you're solving or the feature you're adding.
- Include any relevant issue numbers.
- Make sure your code follows the existing style of the project.
- Write or update tests as necessary.
- Ensure all tests pass before submitting.
If you're unsure about anything, don't hesitate to open an issue to discuss your ideas or ask questions. We appreciate all forms of contributions, from code to documentation improvements!
# License and Contact
This project is published under the [Apache-2.0 License](./LICENSE)
If you are interested in working together, or want to get in contact with me please email me at santiago@tago.works