MISAPP

❯ Devansh Mahant

Built with the tools and technologies:

Table of Contents

• Overview
• Features
• Repository Structure
• Modules
• Getting Started
  • Prerequisites
  • Installation
  • Usage
  • Tests
• Project Roadmap
• Contributing
• License
• Acknowledgments

---

Overview

❯ REPLACE-ME

---

Features

❯ REPLACE-ME

---

Repository Structure

└── misapp/
    ├── README.md
    ├── components.json
    ├── emails
    │   └── verificationEmail.tsx
    ├── next.config.mjs
    ├── package-lock.json
    ├── package.json
    ├── postcss.config.mjs
    ├── src
    │   ├── Schema
    │   ├── app
    │   ├── components
    │   ├── helpers
    │   ├── hooks
    │   ├── lib
    │   ├── middlware.ts
    │   ├── model
    │   └── types
    ├── tailwind.config.ts
    └── tsconfig.json

---

Modules

.

File	Summary
postcss.config.mjs	❯ REPLACE-ME
tailwind.config.ts	❯ REPLACE-ME
components.json	❯ REPLACE-ME
tsconfig.json	❯ REPLACE-ME
package.json	❯ REPLACE-ME
next.config.mjs	❯ REPLACE-ME
package-lock.json	❯ REPLACE-ME

emails

File	Summary
verificationEmail.tsx	❯ REPLACE-ME

src

File	Summary
middlware.ts	❯ REPLACE-ME

src.helpers

File	Summary
sendVerificationEmail.ts	❯ REPLACE-ME

src.types

File	Summary
next-auth.d.ts	❯ REPLACE-ME
ApiResponse.ts	❯ REPLACE-ME

src.model

File	Summary
User.ts	❯ REPLACE-ME

src.Schema

File	Summary
SignInSchema.ts	❯ REPLACE-ME
verifySchema.ts	❯ REPLACE-ME
acceptMessageSchema.ts	❯ REPLACE-ME
messageSchema.ts	❯ REPLACE-ME
signUpSchema.ts	❯ REPLACE-ME

src.components

File	Summary
MessageCard.tsx	❯ REPLACE-ME
Navbar.tsx	❯ REPLACE-ME

src.components.ui

File	Summary
toaster.tsx	❯ REPLACE-ME
tabs.tsx	❯ REPLACE-ME
avatar.tsx	❯ REPLACE-ME
separator.tsx	❯ REPLACE-ME
label.tsx	❯ REPLACE-ME
alert.tsx	❯ REPLACE-ME
dropdown-menu.tsx	❯ REPLACE-ME
badge.tsx	❯ REPLACE-ME
switch.tsx	❯ REPLACE-ME
toast.tsx	❯ REPLACE-ME
select.tsx	❯ REPLACE-ME
card.tsx	❯ REPLACE-ME
alert-dialog.tsx	❯ REPLACE-ME
scroll-area.tsx	❯ REPLACE-ME
input.tsx	❯ REPLACE-ME
button.tsx	❯ REPLACE-ME
form.tsx	❯ REPLACE-ME

src.lib

File	Summary
resend.ts	❯ REPLACE-ME
utils.ts	❯ REPLACE-ME
dbConnect.ts	❯ REPLACE-ME

src.hooks

File	Summary
use-toast.ts	❯ REPLACE-ME

src.app

File	Summary
globals.css	❯ REPLACE-ME
page.tsx	❯ REPLACE-ME
layout.tsx	❯ REPLACE-ME

src.app.(app)

File	Summary
layout.tsx	❯ REPLACE-ME

src.app.(app).dashboard

File	Summary
page.tsx	❯ REPLACE-ME

src.app.(app).u.[username]

File	Summary
page.tsx	❯ REPLACE-ME

src.app.api.check-username-unique

File	Summary
route.ts	❯ REPLACE-ME

src.app.api.suggest-messages

File	Summary
route.ts	❯ REPLACE-ME

src.app.api.sign-up

File	Summary
route.ts	❯ REPLACE-ME

src.app.api.send-message

File	Summary
route.ts	❯ REPLACE-ME

src.app.api.delete-message.[messageid]

File	Summary
route.ts	❯ REPLACE-ME

src.app.api.get-messages

File	Summary
route.ts	❯ REPLACE-ME

src.app.api.accept-messages

File	Summary
route.ts	❯ REPLACE-ME

src.app.api.auth.[...nextauth]

File	Summary
options.ts	❯ REPLACE-ME
route.ts	❯ REPLACE-ME

src.app.api.verify-code

File	Summary
route.ts	❯ REPLACE-ME

src.app.context

File	Summary
authProvider.tsx	❯ REPLACE-ME

src.app.(auth)

File	Summary
layout.tsx	❯ REPLACE-ME

src.app.(auth).sign-in

File	Summary
page.tsx	❯ REPLACE-ME

src.app.(auth).sign-up

File	Summary
page.tsx	❯ REPLACE-ME

src.app.(auth).verify.[username]

File	Summary
page.tsx	❯ REPLACE-ME

---

Getting Started

Prerequisites

TypeScript: version x.y.z

Installation

Build the project from source:

1. Clone the misapp repository:

❯ git clone https://github.com/devansh-m12/misapp

2. Navigate to the project directory:

❯ cd misapp

3. Install the required dependencies:

❯ npm install

Usage

To run the project, execute the following command:

❯ npm run build && node dist/main.js

Tests

Execute the test suite using the following command:

❯ npm test

---

Project Roadmap

• Task 1: Implement feature one.
• Task 2: Implement feature two.
• Task 3: Implement feature three.

---

Contributing

Contributions are welcome! Here are several ways you can contribute:

• Report Issues: Submit bugs found or log feature requests for the misapp project.
• Submit Pull Requests: Review open PRs, and submit your own PRs.
• Join the Discussions: Share your insights, provide feedback, or ask questions.

Contributing Guidelines

1. Fork the Repository: Start by forking the project repository to your github account.
2. Clone Locally: Clone the forked repository to your local machine using a git client.

   git clone https://github.com/devansh-m12/misapp

3. Create a New Branch: Always work on a new branch, giving it a descriptive name.

   git checkout -b new-feature-x

4. Make Your Changes: Develop and test your changes locally.
5. Commit Your Changes: Commit with a clear message describing your updates.

   git commit -m 'Implemented new feature x.'

6. Push to github: Push the changes to your forked repository.

   git push origin new-feature-x

7. Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.
8. Review: Once your PR is reviewed and approved, it will be merged into the main branch. Congratulations on your contribution!

Contributor Graph

---

License

This project is protected under the SELECT-A-LICENSE License. For more details, refer to the LICENSE file.

---

Acknowledgments

• List any resources, contributors, inspiration, etc. here.

---