https://github.com/iitoneloc/next-attache

Portfolio and Resume manager for Next.js
https://github.com/iitoneloc/next-attache

Last synced: 6 days ago
JSON representation

Portfolio and Resume manager for Next.js

• Host: GitHub
• URL: https://github.com/iitoneloc/next-attache
• Owner: iiTONELOC
• License: mit
• Created: 2022-09-08T17:58:26.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-09-09T17:38:13.000Z (over 1 year ago)
• Last Synced: 2023-09-09T18:34:19.416Z (over 1 year ago)
• Language: TypeScript
• Homepage: next-attache.vercel.app
• Size: 2.18 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 🔖 Attaché

### 💼 _Portfolio and Resume Manager for Next.js_

# Screenshot

![screenshot](./assets/screenshot.png)

## Table of Contents

- [Installation](#installation)

- [Usage](#usage)

- [License](#license)

## Installation

## 🛠

1. Clone the repository

   ```bash

   git clone https://github.com/iiTONELOC/next-attache.git

   ```

2. Install dependencies

   ```bash

   npm i

   ```

3. Create the configuration file for the GitHubAPI.

   1. Authentication is required:

      1. Create a [GitHub access token to authenticate your app](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).

      2. Create a `.env.local` and `env.test` file, be sure to replace `username` and `auth` with your GitHub username and previously created auth token.

          ```bash

          npm run env  

          ```

      3. Create the missing envs that are listed in the `.env.local` file.  

          - The following token names were created by the `npm run env` script but their values will need to be updated; be sure to replace the enclosing `< >`s with your unique information. Refer to the previously created `.env.local` file for more information.

        

            - JWT_EXP

            - JWT_SECRET

            - SALT_ROUNDS

            - NEXT_PUBLIC_EMAIL_PUB_TOKEN

            - NEXT_PUBLIC_CAPTCHA_SITE_KEY

            - NEXT_PUBLIC_EMAIL_SERVICE_ID

            - NEXT_PUBLIC_EMAIL_TEMPLATE_ID

## Usage

## 💻

- ### _`Development`_

  ```bash

  npm run dev

  ```

- ### _`Tests`_

  ```bash

  npm run test

  ```

- ### _`Lint`_

  ```bash

  npm run lint

  ```

- ### _`Build`_

  ```bash

  npm run build

  ```

- ### _`Start`_

  - Ensure the build script has been run prior or use the _`development`_ script.

  ```bash

  npm start

  ```

## LICENSE

## 💾

This project is licensed by the [MIT LICENSE](./LICENSE).