Coltensiemer / AWS_Learn

An AWS Quiz maker to practice for the AWS Cloud Certifications.
https://aws-learn.vercel.app
1 stars 0 forks source link
# Project Name
AWS Learn

## Description
This application is tool to study and learn for the AWS cerifications. 
Users have the applility to select options on how they want their quiz and be able to see the results. 

## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
- [Credits](#credits)
- [Contact](#contact)

## Installation
1. Install Node.js and npm if not already installed.
2. Clone the repository:
`
   git clone <repository_url>`
3. Install dependencies:
`
   npm install

## Usage
1. To start the development server, run:
```bash
   npm run dev
  1. To build the project, run:

    npm run build
  2. To start the production server, run:

    npm run start
  3. Create a .env DATABASE_URL="postgresql://{username}:{password}@localhost:{port}/{dbName}?schema=SCHEMA"

  4. How to seed developement DB run:

    npx prisma db seed
  5. How to run StoryBook

    npm run storybook
  6. Additional scripts:

    • lint: Run ESLint for linting.
    • storybook: Start Storybook development server.
    • build-storybook: Build Storybook static files.

Contributing

If you'd like to contribute to the project, please follow these steps:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Make your changes and ensure tests pass.
  4. Commit your changes and push your branch to GitHub.
  5. Open a pull request with a clear title and description.

License

Credits

Acknowledgements for any third-party libraries, resources, or individuals who contributed to the project.

Contact

For questions or inquiries, please contact Colten Siemer at colten50@hotmail.com.