An open API service indexing awesome lists of open source software.

https://github.com/davidgaspardev/web-acton

Acton project
https://github.com/davidgaspardev/web-acton

nextjs prisma reactjs sql typescript

Last synced: 2 months ago
JSON representation

Acton project

Awesome Lists containing this project

README

          

# Acton

Welcome to the Acton Project! Acton is a gym-focused application designed to assist users on their fitness journey by offering quizzes, personalized recommendations, and access to fitness resources.

## Table of Contents

- [Introduction](#introduction)
- [Features](#features)
- [Getting Started](#getting-started)
- [Installation](#installation)
- [Usage](#usage)
- [Technology Stack](#technology-stack)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)

## Introduction

Acton is a comprehensive platform that empowers users to assess their fitness goals, preferences, and special needs. By leveraging interactive quizzes and personalized recommendations, Acton helps users make informed decisions on their fitness journey.

## Features

- Engaging quizzes to evaluate users' fitness goals and requirements.
- Tailored recommendations based on quiz outcomes.
- Access to an array of resources, workout plans, and nutritional guidance.
- Intuitive user interface for seamless navigation and interaction.

## Getting Started

Follow these steps to begin using Acton:

### Installation

1. Clone this repository to your local machine.

```bash
git clone https://github.com/your-username/acton-project.git
cd acton-project
```

2. Install project dependencies.

```bash
yarn
```

### Usage

1. Build the application

```bash
yarn build
```

2. Start the application

```bash
yarn start
```

2. Access Acton through your web browser by visiting `http://localhost:3000`.

## Technology Stack

Acton is built on the following technologies:

- Frontend: React, Next.js
- Backend: Prisma (ORM), MySQL (Database)
- Styling: CSS Modules, Tailwind CSS
- API: Self-hosted Next.js API (for serving API endpoints)

## Contributing

We welcome contributions from the community! To contribute:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Implement your changes and commit them with clear messages.
4. Push your changes to your forked repository.
5. Submit a pull request to the main repository.

## License

Acton is available under the [MIT License](LICENSE).

## Contact

For questions or information, reach out to us at `davidgaspar.dev@gmail.com`.