Skip to content

Commit 5e2af9b

Browse files
committed
Update readme and add env example
1 parent 6aea709 commit 5e2af9b

File tree

2 files changed

+46
-19
lines changed

2 files changed

+46
-19
lines changed

.env.example

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# GENERAL
2+
API_BASE_URL=http://localhost:3000/api
3+
NEXTAUTH_URL=http://localhost:3000
4+
NEXTAUTH_SECRET=secret
5+
6+
# GOOGLE
7+
GOOGLE_CLIENT_ID=id
8+
GOOGLE_CLIENT_SECRET=secret
9+
10+
# DATABASE
11+
MONGO_DB_URI=uri
12+
13+
# AWS
14+
MY_AWS_ACCESS_KEY_ID=id
15+
MY_AWS_REGION=eu-north-1
16+
MY_AWS_SECRET_ACCESS_KEY=key
17+
S3_BUCKET_NAME=bucket_name

README.md

+29-19
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,29 @@
1-
Use npm for install packages
1+
# My Lib – Your Personal Code & Knowledge Organizer
22

3-
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
3+
Effortlessly save, organize, and reuse code snippets, configurations, and technical notes. Built for developers, DevOps engineers, and IT specialists.
4+
5+
https://my-lib-pro.netlify.app
6+
7+
## Features
8+
9+
✅ Save and organize code snippets in multiple languages
10+
✅ Use Monaco Editor for syntax highlighting
11+
✅ Rich text descriptions with images and formatting
12+
✅ Filter by categories and labels
13+
✅ Secure authentication with NextAuth
14+
15+
## Tech Stack
16+
17+
- **Frontend:** Next.js, TypeScript, MUI
18+
- **Backend:** Next.js API routes, Mongoose (MongoDB)
19+
- **Auth:** NextAuth
420

521
## Getting Started
622

7-
First, run the development server:
23+
1. Clone the repository: git clone https://github.com/your-username/my-lib.git
24+
2. Set up environment variables (create a .env.local file):
25+
3. Use npm for install packages: npm install
26+
4. run the development server:
827

928
```bash
1029
npm run dev
@@ -14,23 +33,14 @@ yarn dev
1433
pnpm dev
1534
```
1635

17-
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
18-
19-
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
36+
```md
37+
## License
2038

21-
This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
39+
This project is licensed under the **CC BY-NC 4.0** License – you are free to use, modify, and share this project **for non-commercial purposes only**.
2240

23-
## Learn More
41+
My lib © 2025 by Bohdan Ulich is licensed under CC BY-NC 4.0
2442

25-
To learn more about Next.js, take a look at the following resources:
43+
## Contributing
2644

27-
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
28-
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
29-
30-
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
31-
32-
## Deploy on Vercel
33-
34-
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
35-
36-
Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
45+
Contributions are welcome! Please open an issue or submit a pull request.
46+
```

0 commit comments

Comments
 (0)