Skip to content

Latest commit

 

History

History
62 lines (37 loc) · 1.61 KB

README.md

File metadata and controls

62 lines (37 loc) · 1.61 KB
Raw

nextMotion

An open-source portfolio template

demo

Live Demo

Getting Started

Note

The project is currently in active development, so occasional issues or disruptions can be expected.

To run this project locally, follow the steps below:

1. Fork and Clone the Repository

  • Fork the repository to your GitHub account.

  • Clone the forked repository to your local machine:

    git clone https://github.com/yoyocharlie/nextMotion.git
    cd nextMotion

2. Install Dependencies

  • Install the necessary dependencies using pnpm:

    pnpm install

3. Set Up Environment Variables

  • Create a .env file in the root directory.

  • You only need two environment variables (which will be used for nodemailer):

    • MY_EMAIL
    • APP_PASSWORD

  • This project is using gmail for the nodemailer transport service, so you'll want to create an app password here. This allows your application (this portfolio) to send emails using your Gmail account.

5. Run the Development Server

  • Start the development server:

    pnpm dev

  • Your application should now be running on http://localhost:3000.

A note on deployment

Since our /api/email endpoint requires a server to execute the nodemailer functionality, you'll want to deploy your project through a service that supports serverless functions. Personally, I used Vercel.