Skip to content

Echoes is an article publishing platform inspired by Medium, offering an intuitive and dynamic environment for writers to share their ideas and readers to explore quality content.

License

Notifications You must be signed in to change notification settings

jefersonsilva01/Echoes-backend

Repository files navigation

ECHOES Backend

Table of content

About project

You can see a version of this readme in Portuguese here.

Echoes is an article publishing platform inspired by Medium, offering an intuitive and dynamic environment for writers to share their ideas and readers to explore quality content. With a minimalist design and advanced features, Echoes allows you to create, edit and format texts fluidly, in addition to providing interactions through likes. The platform also includes an intelligent recommendation system, connecting users to relevant content based on their interests. Developed with modern technologies, Echoes seeks to democratize writing and promote the dissemination of knowledge.

You can see a demo here.

Echoes offers a suite of features designed to create a fluid and engaging experience for writers and readers. Here are some of the main features:

Feature

📖 For writers

  • Advanced text editor – Allows you to format texts and add images.
  • Publication – Publish and edit articles already published.

👀 For readers

  • Likes – Interact with the authors.
  • Bookmarking system – Save articles to read later.

🔐 Authentication and community

  • Registration and login – Access via email/password or social networks.
  • User profiles – Customize photo.

⚡ Extras

  • Responsive Design - The website is fully responsive, ensuring a good browsing experience on mobile devices, tablets and desktops.

Stack

  • Figma
  • React
  • Styled Component
  • Javascript
  • NodeJS
  • Express
  • MongoDB
  • Git
  • Github
  • Vercel
  • Google Services
  • Cloudinary

Environment variables

Attention!!! ⚠️

Depending on when you are viewing this project, the access mode to obtain the environment variables may have changed in each service.

Mongo Atlas

The project uses as a database the MongoDB, and the Mongo Atlas as a database server, it will be necessary to use the URL of this environment to be configured so that our data is properly stored and accessed.

Google passport

To use the Google passport authentication method, you must obtain your Client ID and Client Secret through a project created in Console Google Cloud.

Cloudinary

Image files are uploaded via the Cloudinary, where our files are stored and can be accessed, to use the service we need to configure the NAME, KEY and SECRET credentials.

How to run the project

This project is divided into two repositories Backend and Frontend, Frontend is here

To run this project you can download or fork it to your github account and run the git clone command.

git clone https://github.com/<user>/Echoes-backend.git

After accessing the ./Echoes-backend directory and installing the project dependencies, the dependencies can be found through the package.json file, once installed the project can be run in development mode.

cd Echoes-backend

npm install

npm run dev

Ater go to

License

This project is under the MIT license. See the file LICENSE for more details.

About

Echoes is an article publishing platform inspired by Medium, offering an intuitive and dynamic environment for writers to share their ideas and readers to explore quality content.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published