/alurakut

This is a clone of the social network Orkut

Primary LanguageJavaScriptMIT LicenseMIT


Logo

Saull Brandão Saull Brandão License MIT Issues

Alurakut

This is a clone of the social network Orkut

📑 Table of Contents

📃 About the Project

alurakut

  • Login using a github username
  • Uses data from the Github API to display user information(username, profile picture, followers and people you follow)
  • Create a community by providing a name. Can also optionally provide a url for the image cover
  • List of all the communities the user follows
  • Community page, showing all its information

💻 Technologies

🚀 Getting Started

Prerequisites

You will need to install Node.js and yarn

Installation

# Clone Repository
$ git clone https://github.com/saullbrandao/alurakut.git && cd alurakut

# Install Dependencies
$ yarn

# Fill .env.local file with YOUR environment variables, according to .env.example file.

# Run Application
$ yarn dev

This starts the development server on http://localhost:3000/

⁉️ Issues

Create a new issue report, it will be an honor to be able to help you solve and further improve our application.

📫 Contributing

  • Fork this repository;
  • Create a new branch to develop your feature: git checkout -b my-feature;
  • Commit your changes: git commit -m 'feat: my new feature';
  • Push to your branch: git push origin my-feature.
  • Open a Pull Request

🔒 License

Distributed under the MIT License. See LICENSE for more information. Made by Saull Brandão.