Skip to content
/ blog Public template

📝 My small writing blog built with Next.js & Vanilla-extract.

License

Notifications You must be signed in to change notification settings

domin-mnd/blog

Repository files navigation

Blog

Preview banner

About blog

This work is a representation of what I could do with vanilla-extract bundled with next & typescript with the usage of firebase as the database. The site is used to share my writing works.

Installation

Note: I highly suggest you checking out this post on setting up the blog due to upcoming deprecations including the correct usage of assets.

To run this project locally, you need to have Node.js installed on your machine:

git clone https://github.com/domin-mnd/blog . # clone the repository into the current directory
npm install # for the dependencies installation
npm run build # for the production build
npm start # start the server

else you can deploy it on Vercel by using its CLI tool:

npm i -g vercel # install the Vercel CLI tool
vercel # deploy the project

Configuration

To configure this project you need to setup firebase firestore & create web application in the dashboard. After that you need to rename .env.local-example to .env.local and assign corresponding credentials from the web application configuration e.g.:

API_KEY=PIxbSyDxZK0hbAQCbeCMKpwmD0BthIir_l3emIY
AUTH_DOMAIN=[...].firebaseapp.com
DATABASE_URL=https://[...].firebasedatabase.app
PROJECT_ID=[...]
STORAGE_BUCKET=[...].appspot.com
MESSAGING_SENDER_ID=68100932522
APP_ID=1:38180972112:web:d0b1d9d3cf722598dab06a
MEASUREMENT_ID=G-JRZDNGLFE0

Note: The configuration above presented as the example and is incorrect.

Credits

Highly inspired by Katerina Limpitsouni website. Illustrations are taken from Humanities

Documentation

All the available documentation regarding the creation & maintainability of the project is stated in JSDocs and this post.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

This project is under MIT license. You can freely use it for your own purposes.