Skip to content

Repository files navigation

Voxy - Social Story Teller

This is a Next.js project bootstrapped with create-next-app.


Getting Started

To get this project up and running on your local machine, follow these steps:

1. Install Node.js and npm

If you don't have Node.js (which includes npm) installed, you'll need to get it first. You can download the recommended version from the official Node.js website:

Alternatively, you can use a Node.js version manager like nvm (Node Version Manager) for more flexibility.

To verify your installation, open your terminal or command prompt and run:

node -v
npm -v

This should display the installed versions of Node.js and npm.

2. Install Project Dependencies

Navigate to the root directory of your project in your terminal and install all necessary dependencies using npm:

npm install

This command reads the package.json file and installs all the listed dependencies required for the project to run.

3. Configure Environment Variables

Create a file named .env in the root of your project and add the following environment variables. Remember to replace these placeholder values with your actual API keys and secrets.

Generate NEXTAUTH_SECRET:

For the NEXTAUTH_SECRET, it is crucial to use a strong, randomly generated string. You can generate one directly in your terminal using Node.js:

node -e "console.log(require('crypto').randomBytes(32).toString('hex'))"

Copy the output from this command and paste it as the value for NEXTAUTH_SECRET in your .env file.

4. Run the Development Server

Once the dependencies are installed and your environment variables are set, you can start the development server from the app directory:

cp app
npm run dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying app/page.js. The page auto-updates as you edit the file.


Deploy on Vercel

We will deploy our Next.js app using the Vercel Platform from the creators of Next.js.

Check out Next.js deployment documentation for more details.

About

social stories app with the avatar story narration feature

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages