Pen Name Chooser

Pen Name Chooser is a website that helps you to select a unique pen name for your online presence, be it any coding platform, social media platform or content writing platform.

Visit Online

This website is hosted at https://pennamechooser.onrender.com/

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

Your machine should have Npm(or Yarn) and Node.js installed to use it locally.

Setup and Installation

Setting up the repository locally

1. First fork the repo :fork_and_knife: to your account.
   Go to the forked repo and clone it :busts_in_silhouette: to your local machine:

git clone https://github.com/Your_Username/pennamechooser.git

This will make a copy of the code to your local machine.

2. Now, move to the pennamechooser directory.

cd pennamechooser

3. Now, check the remote of your local code by:

git remote -v

The response should look like:

origin  https://github.com/Your_Username/pennamechooser.git (fetch)
origin  https://github.com/Your_Username/pennamechooser.git (push)

To add upstream to remote, run:

git remote add upstream https://github.com/Aman-Codes/pennamechooser.git

Again run git remote -v, the response should look like:

origin  https://github.com/Your_Username/pennamechooser.git (fetch)
origin  https://github.com/Your_Username/pennamechooser.git (push)
upstream    https://github.com/Aman-Codes/pennamechooser (fetch)
upstream    https://github.com/Aman-Codes/pennamechooser (push)

4. Once the remote is set, install all the necessary dependencies by the following command:

npm run install-all

Run locally

Run the below command to start the server:

npm run dev

Go to: http://localhost:3000

Contributing

We really like contributions in several forms, see CONTRIBUTING.md and CODE_OF_CONDUCT.md