SunCityLA Solar Panel Project

Table of Contents

• Overview
• Our Mission
• Visual App Representation
• Project Stack Set Up
• Team Project Documentation
• Our Amazing Team
• Installation

Overview

Solar Panels are aiming to provide sustainable, renewable energy by installing solar PV systems in a designated area, whether it is residential, commercial, or industrial. The system will capture sunlight through photovoltaic cells, convert it into electrical energy, and either supply power to the building or feed it into the electrical grid.

SunCityLA project is a full-stack application, designed to support residents, in one hand, to schedule/manage their appointments and City Hall Employees, in another hand, to manage/plan visits effectively and in a timely manner. The residents can submit requests using preferred times and validated addresses,also allowing to receive notifications regarding their appointments. The app includes an admin interface for authorized City Hall Employees to view as well as resident interface, to plan visit schedules.

Our Mission

SunCityLA project is centered around promoting sustainable energy solutions by harnessing the power of the sun to reduce environmental impact, provide affordable electricity, and contribute to global energy independence. Also Support Economic Growth, Foster Technological Innovation, Encourage Environmental Responsibility, Promote Energy Security, and Inspire Future Generations!

Visual App Representation

Project Stack Set Up:

This Full-Stack app with both frontend and backend components built with NextJS, using the following:

Framework- Next.js(with TypeScript),Tailwind CSS, React Hook Form

UI library- Shadcn

GitHub Authentication- NextAuth.js

Database- Postgres

Deployment Cloud- Vercel

Wireframe- Figma Design

Project Management Tool- GitHub Projects, Google Drive

Team Communication Tools- Discord Channels, Google Meet

Team Project Documentation:

Chingu Product Backlog- Click here

Google Product Backlog- Click here

GitHub Repo: Click here

Link for the App- Click here

Our Amazing Team:

• Isslem Ouederni #1: GitHub / LinkedIn
• Mariana Farcas #2: GitHub / LinkedIn ...
• Abdulsamad Yusuf #3 : GitHub / LinkedIn
• Anna Veselova #4: GitHub / LinkedIn
• Albert Ngodi #5: GitHub / LinkedIn
• Fouad Tabbara #6: - GitHub 🥷

---

Installation

Here's an updated and structured version of the README file with a Setup Instructions section that incorporates the steps shared by the developer:

Prerequisites

Ensure you have the following installed:

• Node.js
• PostgreSQL
• Prisma CLI (optional)

Getting Started

Follow these steps to set up and run the application locally:

1. Clone the Repository
   Clone the project repository to your local machine:

   git clone https://github.com/chingu-voyages/v52-tier3-team-35.git
   cd suncityla
   

2. Create a .env File
   Inside the project root directory, create a .env file and add the following configuration:

   DATABASE_URL=<databse_url>
   NEXTAUTH_SECRET=<your-secret>
   NEXTAUTH_URL=http://localhost:3000
   GITHUB_ID=<your-github-id>
   GITHUB_SECRET=<your-github-secret>

   Make sure to create a github oath keys. You can follow this guide for more details.

3. Install Dependencies
   Install the required dependencies using your preferred package manager:

   npm install
   # or
   pnpm install

4. Update Prisma
   Run the Prisma commands to set up the database schema:

   npm run prisma:update

5. Start the Development Server
   Start the application locally:

   npm run dev

6. Access the Application
   Open your browser and navigate to: http://localhost:3000

7. Test Navigation
   Verify the application by accessing the following links:

   • /admins

   • /bookings``

     Special Thanks to Chingu platform for making this project happened!