Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/woywro/Linkly
:zap: Open source tool to manage bookmarks. Each link can be assigned to collection and each collection can be shared with other users.
https://github.com/woywro/Linkly
Last synced: 2 months ago
JSON representation
:zap: Open source tool to manage bookmarks. Each link can be assigned to collection and each collection can be shared with other users.
- Host: GitHub
- URL: https://github.com/woywro/Linkly
- Owner: woywro
- License: mit
- Created: 2022-02-17T09:11:51.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-10-08T10:40:39.000Z (over 2 years ago)
- Last Synced: 2024-08-08T00:44:54.971Z (6 months ago)
- Language: TypeScript
- Homepage: https://linkly.nersent.com/
- Size: 32.5 MB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- project-awesome - woywro/Linkly - :zap: Open source tool to manage bookmarks. Each link can be assigned to collection and each collection can be shared with other users. (TypeScript)
README
Linkly is an open source tool for managing your website urls like in file manager. As a logged user you can save links and create collections of them. Each collection can be shared with other users. If somebody wants to share collection with you you can accept the request or decline it. You can also access your links history.
## About The Project
This project enables you to manage your links just like in file manager. Most functions and interactions work as in any file manager. Each link keeps it's last modification timestamp, so you can sort your links alphabetically, by owner or by last modification. You can create collections of your links and share them with other users. If at least one of your share requests is accepted, your friend's email should appear on the list when sharing. Each collection can be tagged with color (e.g. all programming related collections). Collections are sorted by last opened by default, however you can set sorting to your own custom order by toggling edit mode and dragging them.
## Built With
- React
- Typescript
- Next.js
- NextAuth
- PostgreSQL
- Prisma
- Redux
- Redux thunk
- Styled Components
## Live version
https://linkly.nersent.com/
If you don't want to authenticate with google/github you can use your email for passwordless login. Simply type in your email, click login button and check your inbox for login token.
## Installation
1. Clone the repo
```sh
git clone https://github.com/woywro/Linkly.git
```
2. Install NPM packages
```sh
npm install
```
3. Set environmental variables in /.env.local
```sh
GOOGLE_CLIENT_ID=...
GOOGLE_CLIENT_SECRET=...
GITHUB_CLIENT_ID=...
GITHUB_CLIENT_SECRET=...
```
4. Add PostgreSQL connection string in prisma/.env
```sh
DATABASE_URL=...
```
5. Run
```sh
npx prisma migrate dev --name "example"
npx prisma generate
```
6. Run the dev server
```sh
npm run dev
```
## Docs
## License
Distributed under the MIT License. See `LICENSE` file for more information.
## Contact
Wojtek Wrotek - [email protected]
## Acknowledgments
Helpful libraries used to make this project:
- [Framer Motion](https://www.framer.com/motion/)
- [Axios](https://axios-http.com/docs/intro)
- [Formik](https://formik.org/)
- [Yup](https://github.com/jquense/yup)
- [MomentJs](https://momentjs.com/)
- [React Icons](https://react-icons.github.io/react-icons/)
- [React Custom Scrollbars 2](https://github.com/RobPethick/react-custom-scrollbars-2)
- [Next SEO](https://github.com/garmeeh/next-seo)
- [Nodemailer](https://nodemailer.com/about/)
- [react-social-login-buttons](https://github.com/MichalSzorad/react-social-login-buttons)
