Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shivabhattacharjee/vermilion
Vermilion is a portfolio website template designed to help you increase your online presence. The website features a stunning black and red color theme that conveys sophistication and energy,
https://github.com/shivabhattacharjee/vermilion
animejs framer-motion nextjs portfolio-project portfolio-template portfolio-website scss stunning-ui typescript
Last synced: 3 days ago
JSON representation
Vermilion is a portfolio website template designed to help you increase your online presence. The website features a stunning black and red color theme that conveys sophistication and energy,
- Host: GitHub
- URL: https://github.com/shivabhattacharjee/vermilion
- Owner: ShivaBhattacharjee
- License: mit
- Created: 2023-05-14T10:36:03.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-01-01T07:00:48.000Z (11 months ago)
- Last Synced: 2024-05-01T13:39:28.555Z (7 months ago)
- Topics: animejs, framer-motion, nextjs, portfolio-project, portfolio-template, portfolio-website, scss, stunning-ui, typescript
- Language: TypeScript
- Homepage: https://vermilion.theshiva.xyz/
- Size: 5.57 MB
- Stars: 18
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Vermilion
A NextJs portfolio website with stunning animation
View Demo
.
Report Bug
.
Request Feature
## Table Of Contents
* [About the Project](#about-the-project)
* [Built With](#built-with)
* [Getting Started](#getting-started)
* [Prerequisites](#prerequisites)
* [Installation](#installation)
* [Hosting](#hosting)
* [Contributing](#contributing)
* [Issue Template](#raising-an-issue)
* [License](#license)
* [Authors](#authors)
## About The Project
Vermilion is a portfolio website template designed to help you increase your online presence. The website features a stunning black and red color theme that conveys sophistication and energy, while smooth animations created using TypeScript and Framer Motion provide a dynamic and engaging user experience.
## Built With
Vermilion is built using upto date technology like NEXTJS SCSS TS Framer-motion and AnimeJs
* [NextJS](https://nextjs.org/)
* [SCSS](https://sass-lang.com/documentation/syntax)
* [FramerMotion](https://www.framer.com/motion/)
* [AnimeJS](https://animejs.com/)
* [TypeScript](https://www.typescriptlang.org/)
## Getting Started
### Prerequisites
Git is a distributed version control system used for software development. It allows multiple developers to work on the same codebase simultaneously, keeping track of changes and managing versions. It also enables users to revert changes and collaborate more effectively.
NodeJs is a JavaScript runtime built on Chrome's V8 JavaScript engine. It allows developers to execute JavaScript code outside of a web browser, making it possible to create server-side applications with JavaScript. Node.js is fast, lightweight, and scalable, making it popular for building modern web applications.
EmailJs is a cloud-based email service that enables you to send emails directly from your website or web application without the need for a server-side application. With EmailJS, you can easily integrate email functionality into your web development projects, allowing you to send custom email templates to your users or customers.
### Installation
create an .env.local file in root directory
```sh
NEXT_PUBLIC_SERVICE_ID= Your emailjs SERVICE_ID
NEXT_PUBLIC_TEMPLATE_ID= Your emailjs TEMPLATE_ID
NEXT_PUBLIC_PUBLIC_KEY= Your emailjs PUBLIC_KEY
```
Get api keys from EmailJs
```sh
git clone https://github.com/ShivaBhattacharjee/vermilion
```
```
cd vermilion
```
```
npm install
```
```
npm run dev
```
## Hosting
(get enviroment variables from emailjs)
* ## Vercel
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FShivaBhattacharjee%2Fvermilion)
* ## Render
[](https://render.com/deploy?repo=https://github.com/ShivaBhattacharjee/vermilion)
## Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
* If you have suggestions for adding or removing projects, feel free to [open an issue](https://github.com/ShivaBhattacharjee/vermilion/issues) to discuss it
* Please make sure you check your spelling and grammar.
### Creating A Pull Request
Wanna contribute to Vermilion ?
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/FeatureName`)
3. Commit your Changes (`git commit -m 'Add some FeatureName'`)
4. Push to the Branch (`git push origin feature/FeatureName`)
5. Open a Pull Request
## Raising an issue
If you're experiencing any problems with Vermilion, please be sure to review our [issue template](https://github.com/ShivaBhattacharjee/vermilion/tree/main/.github/ISSUE_TEMPLATE) before opening a new issue. The template includes a list of questions and prompts that will help us better understand the issue you're experiencing, and it will ensure that we have all of the necessary information to investigate the problem.
We kindly ask that you provide as much detail as possible when submitting an issue, including steps to reproduce the problem, any error messages that you have seen, and any other relevant information. This will help us to identify and fix the issue more quickly.
Thank you for your cooperation, and we look forward to hearing from you!
## License
Distributed under the MIT License . See [LICENSE](https://github.com/ShivaBhattacharjee/vermilion/blob/main/LICENSE) for more information.
## Authors
* **Shiva Bhattacharjee** - [Shiva Bhattacharjee](https://github.com/ShivaBhattacharjee) - *Vermilion*