Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/varshithvhegde/notepage
NotePage is a web application that allows you to easily share code, text, or any content using a unique link.
https://github.com/varshithvhegde/notepage
angular code-share-platform code-sharing firebase text text-editor text-share
Last synced: about 1 month ago
JSON representation
NotePage is a web application that allows you to easily share code, text, or any content using a unique link.
- Host: GitHub
- URL: https://github.com/varshithvhegde/notepage
- Owner: Varshithvhegde
- License: mit
- Created: 2023-10-16T02:20:20.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-23T05:48:16.000Z (10 months ago)
- Last Synced: 2024-03-23T06:35:47.600Z (10 months ago)
- Topics: angular, code-share-platform, code-sharing, firebase, text, text-editor, text-share
- Language: TypeScript
- Homepage: https://notepage.vercel.app
- Size: 221 KB
- Stars: 9
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
NotePage
**NotePage** is a web application that allows you to easily share code, text, or any content using a unique link. You can create new note pages by simply visiting `https://notepage.vercel.app`.
### Features
- **Custom Pages**: Create your own custom pages to share content with others. Just use `https://notepage.vercel.app/` and start sharing.
- **Password Protection**: Optionally protect your pages with a password, ensuring that only authorized users can access your content.
- **Real-time Collaboration**: Collaborate with others in real-time. When multiple users access the same link, any changes made by one user are instantly visible to others, without requiring a page refresh.
- **Shareable Links**: Share your pages with others by sending them the unique link.
### Tech Stack
NotePage is built using the following technologies:
- **Angular**: A powerful and popular front-end framework.
- **Firebase**: A real-time cloud database, authentication, and hosting platform.
- **Angular Material**: A UI component library for Angular applications, providing a set of high-quality components.
- **Nebular**: A customizable Angular UI library and Angular admin template based on Nebular.
### How to Use
1. Visit [https://notepage.vercel.app](https://notepage.vercel.app) to start using NotePage.
2. Create a custom page with your desired name (`https://notepage.vercel.app/`).
3. Optionally set a password to protect your page.
4. Start sharing your link with others.
5. Collaborate in real-time with others on your shared content.
### Installation
To run this project locally, follow these steps:
1. Clone the repository: `git clone `
2. Navigate to the project folder: `cd notepage`
3. Install dependencies: `npm install`
4. Add Angular Material and Nebular to the project: `ng add @angular/material` and `ng add @nebular/theme`
5. Also ensure that you have added your Firebase configuration in `.env` file.
```env
FIREBASE_PROJECT_ID=
FIREBASE_APP_ID=
FIREBASE_DATABASE_URL=
FIREBASE_STORAGE_BUCKET=
FIREBASE_API_KEY=
FIREBASE_AUTH_DOMAIN=
FIREBASE_MESSAGING_SENDER_ID=
FIREBASE_MEASUREMENT_ID=
```
1. Run the development server: `npm run start`
2. Open your web browser and visit `http://localhost:4200`
Now you can explore and test NotePage on your local machine.
### Support and Contributions
If you encounter any issues or have suggestions for improvements, please open an issue on the [GitHub repository](https://github.com/Varshithvhegde/notepage).
You are also welcome to contribute to the project by forking the repository and creating a pull request.
### License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more information.