Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/andrianarivo/snippets

Last synced: about 17 hours ago
JSON representation

Host: GitHub
URL: https://github.com/andrianarivo/snippets
Owner: andrianarivo
License: mit
Created: 2023-12-06T09:04:33.000Z (about 1 year ago)
Default Branch: main
Last Pushed: 2023-12-31T08:13:10.000Z (about 1 year ago)
Last Synced: 2024-04-18T09:35:14.263Z (10 months ago)
Language: TypeScript
Size: 79.1 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        



  


  
Snippets




# 📗 Table of Contents

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

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

    - [Tech Stack](#tech-stack)

    - [Key Features](#key-features)

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

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

  - [Setup](#setup)

  - [Prerequisites](#prerequisites)

  - [Install](#install)

  - [Usage](#usage)

  - [Deployment](#deployment)

- [👥 Authors](#authors)

- [🤝 Contributing](#contributing)

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

- [🙏 Acknowledgements](#acknowledgements)

- [📝 License](#license)

# 📖 Snippet 

**Snippet** is a web application that allows users to save and share code snippets.

## 🛠 Built With 

### Tech Stack 

  Client

  


    React.js

  


  Server

  


    Next.js

  


Database

  


    SQLite

  


### Key Features 

- **Create Snippet**

- **Read Snippet**

- **Update Snippet**

- **Delete Snippet**

(back to top)


## 🚀 Live Demo 

- [Live Demo Link](https://snippets-red.vercel.app/)

(back to top)


## 💻 Getting Started 

To get a local copy up and running, follow these steps.

### Prerequisites

In order to run this project you need:

- **[Node.js](https://nodejs.org/en/)**

- **[npm](https://www.npmjs.com/)** or **[yarn](https://yarnpkg.com/)**

### Setup

Clone this repository to your desired folder:

```sh

  cd my-folder

  git clone [email protected]:myaccount/my-project.git

```

### Install

Install this project with:

```sh

  cd my-project

  npm install

```

### Usage

To run the project, execute the following command:

```sh

  npm run dev

```

### Deployment

You can deploy this project using [Vercel](https://vercel.com/).

```sh

  npm run build

```

(back to top)


## 👥 Authors 

👤 **David**

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

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

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

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

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

(back to top)


## ⭐️ Show your support 

If you like this project give it a ⭐️!

(back to top)


## 🙏 Acknowledgments 

I would like to thank the following for their invaluable help and support:

- [Novity](https://novity.io)

- Stephen Grider for his amazing course on NextJS.

(back to top)


## 📝 License 

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

(back to top)