|
1 | 1 | <div align="center"> |
2 | 2 |
|
| 3 | + |
| 4 | + |
3 | 5 | <img src="public/logo.svg" alt="Notevo Logo" width="64" height="64" /> |
4 | 6 |
|
5 | 7 | # Notevo |
|
31 | 33 | | ⚙️ **CI/CD Setup** | `██████████` |  | 15% | |
32 | 34 | | 🎯 **Issue Response** | `██████████` |  | 10% | |
33 | 35 | | ⭐ **Community Signal** | `█░░░░░░░░░` |  | 5% | |
34 | | - |
35 | | -Improve the repository's documentation by addressing the low "docs" score, currently at 48, to enhance the overall health score of DevLens. |
36 | 36 | <!-- DEVLENS:END --> |
37 | 37 |
|
38 | 38 | --- |
@@ -99,98 +99,16 @@ Open [http://localhost:3000](http://localhost:3000) — that's it. |
99 | 99 |
|
100 | 100 | --- |
101 | 101 |
|
102 | | -## Database Setup |
103 | | - |
104 | | -Migrations live in `supabase/migrations/`. Apply them via the Supabase CLI: |
105 | | - |
106 | | -```bash |
107 | | -npx supabase db push |
108 | | -``` |
109 | | - |
110 | | -Or copy the SQL from `supabase/migrations/` into the Supabase SQL editor manually. |
111 | | - |
112 | | ---- |
113 | | - |
114 | 102 | ## Deploy to Vercel |
115 | 103 |
|
116 | | -One-click deploy — the fastest way to get your own private Notevo instance: |
117 | | - |
118 | 104 | [](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FSamoTech%2Fnotevo) |
119 | 105 |
|
120 | | -Set `NEXT_PUBLIC_SUPABASE_URL` and `NEXT_PUBLIC_SUPABASE_ANON_KEY` in the Vercel environment variables panel during setup. |
121 | | - |
122 | | ---- |
123 | | - |
124 | | -## Pages & Legal |
125 | | - |
126 | | -Notevo ships with complete, production-ready legal and informational pages: |
127 | | - |
128 | | -| Page | Route | Description | |
129 | | -|---|---|---| |
130 | | -| About | `/about` | What Notevo is and how it works | |
131 | | -| Privacy Policy | `/privacy` | GDPR · CCPA · COPPA compliant — zero data collection | |
132 | | -| Terms of Service | `/terms` | Free-forever commitment · MIT license · no warranty | |
133 | | -| Cookie Policy | `/cookies` | No tracking cookies · localStorage only · PECR compliant | |
134 | | -| Sponsor | `/sponsor` | Support the project — keep it free for everyone | |
135 | | - |
136 | | ---- |
137 | | - |
138 | | -## ❤️ Sponsor |
139 | | - |
140 | | -Notevo is free — and will stay free forever. But hosting, infra, and development take real time and money. |
141 | | - |
142 | | -If Notevo saves you time or protects your privacy, consider supporting it: |
143 | | - |
144 | | -**→ [github.com/sponsors/SamoTech](https://github.com/sponsors/SamoTech)** |
145 | | - |
146 | | -| Tier | Amount | What it covers | |
147 | | -|---|---|---| |
148 | | -| ☕ Coffee | $3 one-time | Fuels a bug fix | |
149 | | -| ❤️ Monthly | $5 / month | Hosting & infrastructure | |
150 | | -| 🌟 Patron | $20 / month | Your name in the README | |
151 | | - |
152 | | -Can't sponsor? **Star the repo** ⭐ and share it with someone who values privacy. It means a lot. |
153 | | - |
154 | | -> Notevo will never show ads, sell your data, or add paywalls — no matter what. This is a promise. |
155 | | -
|
156 | | ---- |
157 | | - |
158 | | -## Contributing |
159 | | - |
160 | | -PRs are welcome! Here's how to get started: |
161 | | - |
162 | | -1. Fork the repo and create a feature branch: `git checkout -b feat/my-feature` |
163 | | -2. Make your changes and test locally |
164 | | -3. Run `npm run lint` and `npm run build` — both must pass |
165 | | -4. Open a PR with a clear description of what changed and why |
166 | | - |
167 | | -Issues labelled [`good first issue`](https://github.com/SamoTech/notevo/labels/good%20first%20issue) are a great starting point. |
168 | | - |
169 | | -**Migrating from Laverna?** Open an issue — making that migration path seamless is a top priority. |
170 | | - |
171 | | -See [CONTRIBUTING.md](CONTRIBUTING.md) for full guidelines. |
172 | | - |
173 | | ---- |
174 | | - |
175 | | -## Roadmap |
176 | | - |
177 | | -- [ ] Mobile PWA (installable on iOS/Android) |
178 | | -- [ ] Note sharing with expiring links |
179 | | -- [ ] Folder / notebook hierarchy |
180 | | -- [ ] Rich text (WYSIWYG) mode alongside Markdown |
181 | | -- [ ] Self-hosted Docker image |
182 | | -- [ ] Browser extension for quick capture |
183 | | - |
184 | | -Have an idea? [Open an issue](https://github.com/SamoTech/notevo/issues/new) — community input shapes the roadmap. |
185 | | - |
186 | 106 | --- |
187 | 107 |
|
188 | 108 | ## License |
189 | 109 |
|
190 | 110 | **MIT** — fork it, self-host it, build on it, own it. |
191 | 111 |
|
192 | | -See [LICENSE](LICENSE) for the full text. |
193 | | - |
194 | 112 | --- |
195 | 113 |
|
196 | 114 | <div align="center"> |
|
0 commit comments