Yup or Nope

Tracking and marking attendance, a widely required tool for institutions. It enables teachers to securely log in, adding students and their information, marking attendance by checking boxes and access various functionalities such as report sharing and downloading.

Preview

Table of Contents

1. Tech Stack
2. Features
3. Getting Started
4. Feedback
5. Contributors

Tech Stack

• Next.js
• JavaScript
• Kinde
• Neon - Postgresql
• Drizzle
• Neon
• HTML5
• CSS3
• React.js
• Node.js
• NPM
• Tailwind CSS

Features

• Authentication: Implements authentication and authorization features using Kinde, allowing users to securely log in via social sign-on or traditional email and password methods, while ensuring appropriate access levels and permissions within the platform.

• Appealing Interface: On home page bar graphs and pie charts are there, select month and grade and booooom.

• Report Sharing: Share attendance report with others easily via any social media or apps.

• Collaboration: Any class teacher can simultaneously access whole school students list and can mark attendance.

• Adding Students: Onboard students with the correct and relevant information.

• Delete Students: Easily delete students from the students list in case he/she no more in your institution.

• Report Download: Use Download section to get all the data saved in your device.

• Search Functionality: Powerful search tools to quickly locate students using roll number, grade & section, or address.

• Mark Attendance: Go to attendance section choose the class and start marking attendance also can see previous months attendance.

• Security Features: Protect account with encryption and two-factor authentication for added security.

• Responsive Design: Follows responsive design principles to ensure optimal user experience across devices, adapting seamlessly to different screen sizes and resolutions.

Getting Started

Prerequisites

• Git
• Node.js
• npm (Node Package Manager)

Cloning

1. Cloning:

   Run the following command in your terminal or command prompt to clone the repository to your local machine:

   git clone https://github.com/theankushshah/Yup-or-Nope.git

2. Navigate to the Directory:

   Once cloned, navigate into the project directory using the cd command:

   cd yup-or-nope

Download

1. Download ZIP Code folder:

   Unzip the folder in your machine.

2. Navigate to the Downloaded Directory:

   Open your code editor and open the unzipped folder in it then:

   cd /path/to/downloaded/folder

Cloning & Download

1. Dependencies Installation:

   npm install

2. Environment Variables & Database Setup:

   Create a new file named .env in the root of your project and add the following content:

   KINDE_CLIENT_ID=
   KINDE_CLIENT_SECRET=
   
   KINDE_ISSUER_URL=
   KINDE_SITE_URL=
   
   KINDE_POST_LOGOUT_REDIRECT_URL=
   KINDE_POST_LOGIN_REDIRECT_URL=
   
   DRIZZLE_DATABASE_URL=

   Don't get confuse by DRIZZLE_DATABASE_URL

   It's actually Neon Postgresql Database but I just named it like DRIZZLE_DATABASE_URL

   Replace the placeholder values with your actual Kinde & Database credentials. You can obtain these credentials by signing up on the Kinde website and Neon website

3. Database Run:

   Run the following command to run the database:

   npm run db:push
   npm run db:studio 

   Open https://local.drizzle.studio in your browser to view the database.

4. Running:

   npm run dev

   Open http://localhost:3000 in your browser to view the project.

5. Start Coding:

   Feel free to edit the code according to your requirements.

6. Testing

   npm test

7. Build for Production

   npm run build

Github

1. Initialize a New Git Repository:

   git init

2. Stage and Commit the Code:

   git add .
   git commit -m "Initial commit"

3. Create a New Repository on GitHub:

   Do not initialize the new repository with a README, .gitignore, or license.

4. Link Local Repository to GitHub:

   git remote add origin https://github.com/username/new-repo.git

   Replace https://github.com/username/new-repo.git with your actual repository URL.

5. Push Code to GitHub:

   git branch -m main
   git pull origin main
   git push -u origin main

6. Deployment:

   Deploy the application to your preferred hosting platform to make it accessible online.

Forking

1. Forking:

   Run the following command in your terminal or command prompt to fork the repository to your local machine:

   git clone https://github.com/your-username/Yup-or-Nope.git

2. Navigate to the Directory:

   Once cloned, navigate into the project directory using the cd command:

   cd yup-or-nope

3. Start Coding:

   Make the additions & desired changes to the code.

4. Commit & Push Your Changes to Your Fork:

   Once cloned, navigate into the project directory using the cd command:

   git add .
   git commit -m ""
   git pull origin main
   git push -u origin main

5. Create a Pull Request:

• Go to your forked repository on GitHub

• Click the "Compare & pull request" button.

• Review your changes and write a clear description of your contribution.

• Click "Create pull request"

  I will review your pull request and decide whether to merge your changes into my repository or not

Feedback

You might encounter some bugs while using this app. You are more than welcome to contribute. Just submit changes via pull request and I will review them before merging. Make sure you follow community guidelines.

Contributors & Main

• Ankush Shah (ankushsahvlogs@gmail.com)
• Haven Futures (support@havenfutures.com) (Main)

Happy coding!