Omaha Playground Collective app

• Omaha Playground Collective app
  • Project Summary
  • Installation
  • Getting Started
  • License
• The Stories
  • User Stories
  • Acceptance Criteria
  • Mis-user Stories
  • Mitigation Criteria
• Diagrams
  • Mockup
  • Architecture Diagram

Project Summary

The Omaha Playground Collective is your ultimate source for all things playgrounds, parks + fun in Omaha, Nebraska. Our mission is to provide a comprehensive guide to help you discover the best recreational spaces for your family.

Installation

You'll need a Supabase and GitHub account to run this app locally.

You'll need to clone the GitHub repo to your local machine.

You'll need to add the .env file with your DATABASE_URL, GITHUB_ID, GITHUB_SECRET, NEXTAUTH_URL, and NEXTAUTH_SECRET.

Environment Variables

You'll need to add the following environment variables to your .env file. There is an example .env file in the root directory of the project called .env.example. You can copy this file and rename it to .env. You'll need to add your own values to the variables in the .env file.

DATABASE_URL

To use the Supabase database in the app, you'll need to add the connection string to your .env file. Here is an example of what that looks like:

# .env file
DATABASE_URL=postgres://postgres:<password>@local<your_supabase_url>.host:5432/postgres

Next Auth

• To use the app, you'll need to add the NEXTAUTH_SECRET and NEXTAUTH_URL in your .env file. You can generate a new secret on the command line with openssl rand -base64 32 Here is an example of what that looks like:

# .env file
NEXTAUTH_SECRET=<your_nextauth_secret>
NEXTAUTH_URL="http://localhost:3000"

Github Provider

• To use Nextauth in the app, you'll need to add the Next Auth Github Provider to your .env file. Here is an example of what that looks like:

# .env file
GITHUB_ID=<your_github_id>
GITHUB_SECRET=<your_github_secret>

Getting Started

Local Development

To set up the project for local development, follow these steps:

1. Clone the repository:

   git clone https://github.com/your-username/omaha-playground-collective.git
   cd omaha-playground-collective

2. Install dependencies:

   npm install

3. Set up environment variables:

   • Copy the example environment file and update it with your own values:

     cp .env.example .env

   • Edit the .env file to include your own values for the environment variables.

4. Run the development server:

   npm run dev

   This will start the development server on http://localhost:3000.

5. Access the application: Open your browser and navigate to http://localhost:3000 to see the application running locally.

Docker Development

You can also use Docker to set up the project for local development. Here are the steps:

1. Build the Docker image:

   docker build -t omaha-playground-app .

2. Run the Docker container:

   docker run -p 3000:3000 --env-file .env omaha-playground-app

   This will build the Docker image with the tag omaha-playground-app and run a container from that image, mapping port 3000 of the container to port 3000 on your host machine. The --env-file .env option ensures that the environment variables from your .env file are passed to the container.

3. Access the application: Open your browser and navigate to http://localhost:3000 to see the application running in the Docker container.

4. Check container logs (if needed):

   docker logs <container_id>

   Replace <container_id> with the actual container ID, which you can find using:

   docker ps

By following these steps, you should be able to set up and run the Omaha Playground Collective app locally for development.

License

This project is licensed under the terms of the Creative Commons Zero v1.0 Universal.

The Stories

User Stories

User Story 1

As a parent, I want to access playground information to discover suitable options for my family.

User Story 2

As a parent, I want to find playgrounds for my family quickly based on criteria like appropriate options or playground surface type.

User Story 3

As an administrator, I want to share playground information with other parents to use.

User Story 4

As an administrator, I want to manage playground information to ensure it's up-to-date and accurate.

Acceptance Criteria

Acceptance Criteria 1

Given that I am a parent looking for playgrounds, when I access the playground information, then I should be able to view a list of playgrounds in my area with details such as location, facilities, and rating.

1. The system should display a user-friendly interface for accessing playground information.
2. Users should be able to easily browse and filter the list of playgrounds.
3. The playground information should be categorized by location, age range, rating, and playground surfaces.
4. Each playground entry should include details, including its name, address, age range, shade, and other relevant information.

Acceptance Criteria 2

Given that I am a parent finding for a playground, when I perform a filter using the predefined critera, then I should receive relevant results based on my filter options.

1. The filter functionality should be easily accessible from the main interface.
2. Users should be able to enter filter by such as location, age range, surface area, and ada compliance.
3. The filter results should include playgrounds that match the filter criteria.
4. The results should be displayed in an organized and easily readable format.
5. Users should be able to click on a result to access more detailed information about the playground.

Acceptance Criteria 3

Given that I am an administrator wanting to share playground information, when I create an entry, then I should be able to publish it to the app.

1. The system should provide a blog creation interface within the administrator's dashboard.
2. Administrators should be able to input relevant information about the playground, including its name, location, facilities, and any additional useful details.
3. Administrators should be able to format and structure the blog post, including adding text, images, and links.
4. Once the blog post is created, administrators should be able to publish it.
5. The published blog post should be accessible to other parents using the application

Acceptance Criteria 4

Given that I am an administrator responsible for managing playground information, when I update playground details, then the changes should be reflected in the app, and the information should remain accurate.

1. The platform should provide an interface for administrators to edit, update, and delete playground information.
2. After making changes, the updated information should be displayed or removed from the application.
3. Users accessing the platform should see the most recent, active, and accurate playground details.
4. Any changes made by administrators should be tracked and documented for reference.

Mis-user Stories

Mis-user Story 1

As a hacker, I want to exploit vulnerabilities in the search feature to gain unauthorized access to the backend system.

Mis-user Story 2

As an administrator, I accidentally delete or update playground information to provide incorrect details.

Mitigation Criteria

Mitigation Criteria 1

• Regularly conduct security assessments, including penetration testing and vulnerability using tools such as OWASP ZAP and SonarQube.
• Implement strong access controls and authentication mechanisms to prevent unauthorized access to data.
• Maintain audit logs to capture details of access attempts, user activities, and system changes.

Mitigation Criteria 2

• Implement a content log that records all changes made by administrators, making it possible to track and reverse unauthorized modifications.
• Maintain a robust data recovery and backup system to ensure that data can be restored in the event of accidental deletion or modification.

Diagrams

Mockup

Home page

Blog Page

Search Result Page

Architecture Diagram

Context Diagram

Container Diagram

Component Diagram