Esfahani Theme

The Esfahani Theme is a multilingue NuxtJs theme which aims to modernize, organize and enhance some aspects of personal website or weblog themes development.

Live Demo

Live production demo is available on esfahani.dev.

How it works:

• NuxtJs SSR
• Prismic Headless CMS
• Vercel Deployment
• Typescript
• ES6 for JavaScript
• SASS preprocessor for CSS

Setup

Install the project:

$ git clone https://github.com/aynzad/esfahani-nuxt-theme.git
$ yarn
$ mv .env.sample .env

Create a Prismic repository

1. Create your prismic account.
2. Create a repository
3. Add your prismic API_URL to the .env file.
4. Create a about custom type, using about.json file.
5. Create a contact custom type, using contact.json file.
6. Create a articles custom type, using articles.json file.

Deploy on Vercel (optional)

You can use Vercel for CI and CD your own fork of this project.

1. Create your Vercel account.
2. Create a Project and import your git repository.

Contributing

Great that you are considering supporting the project. You have a lot of ways to help me grow. I appreciate all contributions, even the smallest.

• Report an issue.
• Propose a feature.
• Send a pull request.
• Star project on the GitHub
• Tell about project around your community.

TODO

• Config test packages (like jest).
• Add unit test.
• Add projects page.
• Add RSS feed.
• Improve SEO.

License

It is licensed under the MIT license.