Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rileymanda/next-support

A simple nextjs full stack support application that enables users to signin and create and view cases and case status
https://github.com/rileymanda/next-support

eslint fluentui nextauth nextjs13 reactjs typescript

Last synced: about 6 hours ago
JSON representation

A simple nextjs full stack support application that enables users to signin and create and view cases and case status

Awesome Lists containing this project

README 

        






  logo

  



  
NextSupport






# 📗 Table of Contents



- [📖 About the Project](#about-project)

  - [🛠 Built With](#built-with)

    - [Tech Stack](#tech-stack)

    - [Key Features](#key-features)

- [💻 Getting Started](#getting-started)

  - [Prerequisites](#prerequisites)

  - [Setup](#setup)

  - [Install](#install)

  - [Usage](#usage)

  - [Run tests](#run-tests)

- [👥 Authors](#authors)

- [🔭 Future Features](#future-features)

- [🀝 Contributing](#contributing)

- [⭐ Show your support](#support)

- [🙏 Acknowledgements](#acknowledgements)

- [❓ FAQ (OPTIONAL)](#faq)

- [📝 Attribution](#attribution)

- [📝 License](#license)



# 📖 NextSupport 



Next Support is a nextjs full stack application that enables users to signin | signup and create cases.



## 🛠 Built With 



### Tech Stack 



  Microsoft Fluent UI framework (v9)

  



  NextJs

  



  Typescript

  



  NextAuth

  



## 🛠 Key Features 

### Features 



> Signup



> SignIn



> Create Cases



> View Cases





(back to top)



## 💻 Getting Started 



To get a local copy of the project and run it, follow the following Steps and Prerequisites.



### Prerequisites



In order to run this project you need:



> Node js installed on your local machine



> A package manager such as npm, yarn or pnpm



> A code editor such as Visual Studio Code, Sublime Text, Atom, etc.



> A web browser such as Chrome, Firefox, Safari, etc.



> A terminal or command line interface



> A git client installed on your local machine



> A github account



### Setup



Clone this repository to your desired folder:



```sh

cd my-folder

git clone https://github.com/RileyManda/next-support.git

```



### Install



```sh

  cd next-support

```

Install dependencies:

```sh

  yarn

```



Generate your secret:

```sh

 openssl rand -base64 32

```



Create an env file(.env.local) and add your own environment variables:



```sh

NEXTAUTH_SECRET=Yoursecret

USER_ID=1

USER_NAME=riley

USER_PASSWORD=next-app

```



### Usage



To run the project, execute the following command:



```bash

yarn dev

```



Alternatively if using npm package manager:



```bash

npm run dev

```



If using pnpm package manager:



pnpm dev

# or

bun dev



### Run tests



To run tests, run the following command:



```sh

  yarn test

```



### Deployment



You can deploy this project using:



```sh

    yarn build

```



Then follow the deployment instructions for your preferred hosting platform.



(back to top)



## 👥 Authors 



👀 **RileyManda**



- GitHub: [@RileyManda](https://github.com/RileyManda)

- Twitter: [@rilecodez](https://twitter.com/rileycodez)

- LinkedIn: [rileymanda](https://www.linkedin.com/in/rileymanda/)



(back to top)



## 🔭 Future Features 



> Improve UI component theme



> Add more user authentication options



(back to top)



## 🀝 Contributing 



Contributions, issues, and feature requests are welcome!



Feel free to check the [issues page](https://github.com/RileyManda/NextSupport/issues).



(back to top)



## Show your support 🌟



Thank you for taking the time to explore this project! Your support means a lot to me. If you find my project valuable and would like to contribute, here is one way you can support me:



 - Star the project ⭐: Show your appreciation by starring this GitHub repository. It helps increase visibility and lets others know that the project is well-received.



 - Fork the project 🍎 🎣: If you're interested in making improvements or adding new features, feel free to fork the project. You can work on your own version and even submit pull requests to suggest changes.



 - Share with others 🗺: Spread the word about this project. Share it on social media, mention it in relevant forums or communities, or recommend it to colleagues and friends who might find it useful.



(back to top)



## 🙏 Acknowledgments 



I would like to express my gratitude to DataBalk for the opportunity to create this exciting and fun project.

Your contributions have been instrumental in the success of this project, and I'm thankful for the knowledge and resources you've added to my developer jourmey.



(back to top)



## ❓ FAQ 



- **Question_1**



  Do I have to use the vs code specifically?



  - Answer_1



    You can use any code editor of your choice. 



- **Question_2**



  Where can I download node JS for installation?



  - Answer_2



  Node.js® is a JavaScript runtime built on Chrome's V8 JavaScript engine.

  It can be downloaded [here](https://nodejs.org/en).



(back to top)



## 👥 Attribution 

- Original logo design template from: [Svgrepo](https://www.svgrepo.com/)



## 📝 License 



[![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](./LICENSE)



(back to top)