Skip to content

Latest commit

 

History

History
137 lines (81 loc) · 4.14 KB

README.md

File metadata and controls

137 lines (81 loc) · 4.14 KB
Raw

thinkIt-writeIt - Web Application

Think It Write It is a modern web application designed to facilitate creative expression through writing. Built with Next.js, Chakra UI, NextAuth, Node.js, Express.js, and MongoDB, this project offers a seamless user experience for writers to showcase their personality.

Table of Contents

Introduction

Think It Write It was conceived as a learning project to dive deep into the realms of Next.js, Chakra UI, Node.js, Express.js, and MongoDB. It serves as a practical exploration of these technologies, focusing on creating a user-centric platform for writers. The project emphasizes the importance of user profiles, allowing writers to showcase their personality, interests, and achievements through fields such as favorite content, bio, and social media links.

This repository contains the source code for the thinkIt-writeIt web application. With a sleek and user-friendly design, the application is built using Next.js, Chakra UI, NextAuth.js, Express.js, Node.js, MongoDB.

Features

Home Page:

  • Newsletter Subscription: Easily sign up to receive updates and newsletters directly to your inbox.
  • Email Confirmation: Upon subscription, a confirmation email is sent to verify your address.

Registration & Login

  • User Registration: Sign up with your email, password, and confirm password to create an account.
  • Login: Securely log in with your credentials to access personalized features.

User Profile

  • Personal Information: View and edit your profile details, including name, username, social media links, favorite quote, and 'About Me' section.
  • Authentication Required: Access to this page requires login to ensure privacy and security.

Username Display

  • Public Viewing: View a specific username's details without needing to authenticate. Ideal for discovering new writers and their work.

Technologies Used

The thinkIt-writeIt web application is built using the following technologies:

  • Next.js: A React framework for building server-side rendered and static web applications.
  • Chakra UI: A simple, modular, and accessible component library that gives you the building blocks you need to build your React applications.
  • NextAuth.js: A complete open-source authentication solution for Next.js applications.
  • Node.js & Express.js: A powerful combination for building fast, scalable network applications.
  • MongoDB: A source-available cross-platform document-oriented database program.

Installation

To get started with Think It Write It, follow these steps:

Client-Side (Next.js)

  1. Clone the repository:

    git clone https://github.com/YourmixJNR/thinkIt-writeIt.git

  2. Navigate to project directory:

    cd client

  3. Install the dependencies

    npm install

  4. Start the development server

    npm run dev

  5. Open your browser and visit http://localhost:3000 to see the application running locally

Server-Side (Express.js)

  1. Clone the repository:

    git clone https://github.com/YourmixJNR/thinkIt-writeIt.git

  2. Navigate to project directory:

    cd server

  3. Install the dependencies

    npm install

  4. Start the development server

    npm start dev

  5. Ensure MongoDB is running and configured correctly according to your setup.

Note:

In the client and server directory, check the env.example to set up your own env

  • Create an .env file and copy the contents from the .env.example to the file and set the respective values.

License

This project is licensed under the MIT License.

Contributing

Contributions are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request.

Contact