Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/wesleybertipaglia/bio

🌲 Bio is a simple website project that allows you to create and manage a list of links. It’s inspired in Linktree and some popular Instagram bio websites.
https://github.com/wesleybertipaglia/bio

bio links linktree project react website

Last synced: about 2 hours ago
JSON representation

🌲 Bio is a simple website project that allows you to create and manage a list of links. It’s inspired in Linktree and some popular Instagram bio websites.

Awesome Lists containing this project

README

        

# 🌲 Bio
Bio is a simple website that allows you to create and manage a list of links. It’s inspired in Linktree and some popular Instagram bio websites.

![screenshot](/docs/screenshot.png)

### Features:

- βœ… Easy to use and customize
- βœ… Simple, clean and responsive design
- βœ… Sections for categorized links
- βœ… Sharable link to your Bio page
- βœ… Dark mode
- βœ… Tailwind CSS for quick and efficient styling
- βœ… Jest for testing components
- βœ… Easy to deploy

## πŸ“š Table of Contents
- [Getting Started](#getting-started)
- [Commands](#-commands)
- [Endpoints](#-endpoints)
- [Tech Stack](#-tech-stack)
- [License](#-license)
- [Checklist](#-checklist)

To know more about the project structure, check the [structure.md](/docs/structure.md) file.

## πŸ€– Getting Started
1. Clone the repository

```bash
git clone https://github.com/wesleybertipaglia/bio.git
```

2. Install dependencies:

```bash
npm install
```

3. Customize the content:
Update the `src/data/links.js` file to include your personal links and categories.

4. Start the development server:
```bash
npm start
```

> πŸš€ Open your browser and go to [http://localhost:3000](http://localhost:3000) to see the website in action.

## 🧞 Commands

All commands are run from the root of the project, from a terminal:

| Command | Action |
| :------------------------ | :---------------------------- |
| `npm install` | Install dependencies |
| `npm start` | Start application |
| `npm build` | Build application |
| `npm test` | Run tests |

## 🧩 Tech Stack
- [JavaScript](https://developer.mozilla.org/en-US/docs/Web/JavaScript)
- [React](https://reactjs.org/)
- [Jest](https://jestjs.io/)
- [Tailwind CSS](https://tailwindcss.com/)

## β˜‘οΈ Cheklist

The following checklist can be used to track the project progress:

- [x] Authentication
- [x] Authorization
- [x] Documentation
- [x] Tests
- [x] CI/CD
- [x] Deploy
- [x] Monitoring

## πŸ“œ License

This repository is licensed under the [MIT]. See the [LICENSE](LICENSE) file for details.

[Back to top](#bio)