Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/hqasmei/site-muse

An open-source tool for developers and designers to manage bookmarks and streamline research and inspiration.
https://github.com/hqasmei/site-muse

Last synced: about 1 month ago
JSON representation

An open-source tool for developers and designers to manage bookmarks and streamline research and inspiration.

Awesome Lists containing this project

README

        


SiteMuse – an open-source tool for developers and designers to manage bookmarks and streamline research and inspiration..

SiteMuse



An open-source tool for developers and designers to manage bookmarks and streamline research and inspiration.



Twitter


License


Introduction ·
Local Development ·
Tech Stack ·
Contributing



## Introduction

SiteMuse is an open-source link management tool for modern marketing teams to create, share, and track short links. Built with [Next.js 13](https://nextjs.org/), [PlanetScale MySQL](https://planetscale.com/) and [Screenly](https://3.screeenly.com/).

## Local Development

To develop SiteMuse locally, you will need to clone this repository and set up all the env vars outlined in the [`.env.template` file](https://github.com/hqasmei/site-muse/blob/main/.env.template).

Once that's done, you can use the following commands to run the app locally:

```
npm install
npm run build
npm run dev
```

## Tech Stack

- [Next.js](https://nextjs.org/) – framework
- [Typescript](https://www.typescriptlang.org/) – language
- [Tailwind](https://tailwindcss.com/) – CSS
- [Vercel Analytics](https://vercel.com/) – analytics
- [PlanetScale](https://planetscale.com/) – database
- [UploadThing](https://uploadthing.com/) – database
- [Clerk](https://clerk.com/) – auth
- [Screenly](https://3.screeenly.com/) - screenshots
- [Vercel](https://vercel.com/) – hosting

## Contributing

We love our contributors! Here's how you can contribute:

- [Open an issue](https://github.com/hqasmei/site-muse/issues) if you believe you've encountered a bug.
- Make a [pull request](https://github.com/hqasmei/site-muse/pull) to add new features/make quality-of-life improvements/fix bugs.



## Repo Activity

![SiteMuse repo activity – generated by Axiom](https://repobeats.axiom.co/api/embed/8afeda90cdfbea99b4d4b9e2290e105b0f1b093c.svg 'Repobeats analytics image')

## License

SiteMuse is open-source under the GNU Affero General Public License Version 3 (AGPLv3) or any later version.