https://github.com/praisespjmt/project-template

Template repository for projects
https://github.com/praisespjmt/project-template

Last synced: 6 months ago
JSON representation

Template repository for projects

• Host: GitHub
• URL: https://github.com/praisespjmt/project-template
• Owner: PraisesPJMT
• License: mit
• Created: 2023-02-16T08:16:01.000Z (over 3 years ago)
• Default Branch: development
• Last Pushed: 2023-02-16T08:23:18.000Z (over 3 years ago)
• Last Synced: 2025-04-05T12:11:11.296Z (about 1 year ago)
• Size: 2.93 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# 📗 Table of Contents 

- [📗 Table of Contents ](#-table-of-contents-)

  - [📖 Project Title ](#-project-title-)

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

    - [⚙️ Tech Stack ](#️-tech-stack-)

    - [💡 Key Features ](#-key-features-)

  - [🎞️ Preview ](#️-preview-)

  - [🚀 Live Demo ](#-live-demo-)

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

    - [Prerequisites](#prerequisites)

    - [Setup](#setup)

    - [Install](#install)

    - [Usage](#usage)

  - [👥 Authors ](#-authors-)

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

  - [🤝 Contributing ](#-contributing-)

  - [⭐️ Show your support ](#️-show-your-support-)

  - [❓ FAQ ](#-faq-)

  - [🙏 Acknowledgments ](#-acknowledgments-)

  - [📝 License ](#-license-)

## 📖 Project Title 

> Brief description of the project.

## 🛠 Built With 

> Describe the tech stack and include only the relevant sections that apply to your project.

### ⚙️ Tech Stack 

> Here are the tech stacks applied in this project.

  Language

  


    
Typescript

  


  Framework

  


    
ReactJS

  


  Markup Languages

  


    
HTML5

    
SASS

  


(back to top)


### 💡 Key Features 

> Describe between 1-3 key features of the application.

- **[key_feature_1]**

- **[key_feature_2]**

- **[key_feature_3]**

(back to top)


## 🎞️ Preview 

> Comming soon ...

## 🚀 Live Demo 

> Comming soon ...

(back to top)


## 💻 Getting Started 

### Prerequisites

> Describe how a new developer could make use of your project.

> The following applications are required to be installed for the project to run!

- Install a modern browser e.g [Google Chrome](https://www.google.com/chrome/), [Edge](https://www.microsoft.com/en-us/edge?r=1), [Firefox](https://www.mozilla.org/en-US/exp/firefox/new/) etc.

- Install [Node.js](https://nodejs.org/en/download/) LTS version

- Install [Git](https://git-scm.com/downloads)

### Setup

Clone this repository to your desired folder:

```sh

  git clone git@github.com:PraisesPJMT/lendsqr-fe-test.git.git

  cd lendsqr-fe-test

```

### Install

Install this project with:

```sh

  npm install

```

### Usage

To run the project, execute the following command:

```sh

  npm run dev

```

- After running `npm run dev`, use the app on [http://localhost:5173/](http://localhost:5173/) in the browser!

- For more information please visit [Vite](https://vitejs.dev/guide/).

(back to top)


## 👥 Authors 

👤 **Praises Tula**

[![GitHub](https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge&logo=github&logoColor=white)](https://github.com/PraisesPJMT/)

[![LinkedIn](https://img.shields.io/badge/linkedin-%230077B5.svg?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/praises-tula/)

[![Twitter](https://img.shields.io/badge/Twitter-%231DA1F2.svg?style=for-the-badge&logo=Twitter&logoColor=white)](https://twitter.com/PraisesPJMT/)

[![Gmail](https://img.shields.io/badge/Gmail-D14836?style=for-the-badge&logo=gmail&logoColor=white)](mailto:praisesmusa@gmail.com)

[![AngelList](https://img.shields.io/badge/AngelList-%23D4D4D4.svg?style=for-the-badge&logo=AngelList&logoColor=black)](https://angel.co/u/praises-tula/)

## 🔭 Future Features 

> Describe 1 - 3 features you will add to the project.

- [ ] **[new_feature_1]**

- [ ] **[new_feature_2]**

- [ ] **[new_feature_3]**

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)


## ⭐️ Show your support 

Give a ⭐️ if you like this project!

(back to top)


## ❓ FAQ 

- **How I can run this project?**

  - After cloning repository, run `npm install` to install all dependencies. Then run `npm run dev` to run the project.

- **How I can run tests?**

  - After cloning repository, run `npm install` to install all dependencies. Then run `npm test` to run the tests.

(back to top)


## 🙏 Acknowledgments 

> - Tip hart to you for checking this project out

(back to top)


## 📝 License 

This project is [MIT](./LICENSE) licensed.