Social Media - FE

This is a social media project built with Next.js, Tailwind CSS, and Edgestore. It's a work in progress, so there's a lot of things to do. You can find the backend repository here.

Table of Contents

Technologies Used

  • Next.js - A React framework for building web applications.
  • dayjs - A minimalist JavaScript library for parsing, formatting, and manipulating dates.
  • Tailwind CSS - A utility-first CSS framework.
  • Axios - Promise-based HTTP client for making requests.
  • Cookies - A JavaScript API for working with cookies.
  • Socket.io - A real-time, bidirectional communication library.
  • Edgestore - A database for the decentralized web.

Requirements

Before getting started, make sure you have the following installed:

Installation

To get started with this project, follow these steps:

  1. Clone the Repository:
   git clone git@github.com:GabrielFeBe/Social-media-fe.git
   #then
   cd Social-media-fe
  1. Install Dependencies:
   npm install

Usage

npm run dev

Configuration

  • Port: The default port is 3000, but you can change it if you want. You can find the port configuration in the next.config.js file.
  • Docker: There's not a Dockerfile yet, nor a docker-compose.yml file. But it's in the roadmap.
  • Environment Variables: There's a .env.example file with all the environment variables needed to run the project. You can create a .env file and copy the variables from the .env.example file and fill them with your own values.
  • Backend: The backend is not hosted, so you'll need to run it locally. You can find the backend repository here

Edgestore

  • Edgestore: This project uses Edgestore as a database. You can find the documentation here. You can create a free account and use it for development purposes. You'll need to create a database and a collection. Then you'll need to create a .env file and add the following variables:
  • The keys are the same as the ones in the .env.example file, but you'll need to add your own values.

License

This project is licensed under no license =/.