Skip to content

UnitWe/CampusConnect-User-Service

Repository files navigation

👩🏻‍💻 DEV.TO CLONE - BACK-END PROJECT 👩🏻‍💻

Description ✍️

An initiative among friends and university colleagues to create a social network for technology undergraduates at the Catholic University of Pernambuco. The web application was inspired by the blog-like publication site called Dev.to, with the intention of creating an environment where we students can share our experiences and knowledge with other colleagues from the university.


Table of Contents 📋


Installation 💿

First, make sure that you have nodejs version 16 or higher installed on your machine.

After that, install the project's dependencies using the command:

npm i

Usage 🧑🏾‍💻

To start the application you can use the command:

npm run start

API Documentation 📚

In construction...


Configuration ⚙️

To be able to run our application locally we must create a new .env file in the main project directory. A template file is already provided where it shows which environment variables are used, just create an .env file in the same location as the .env.example, copy the content provided in it and paste it in the file you created modifying it to the settings of your local machine.

Now your environment is ready to start the project.


Contributing 💻


Gabriel Luna

Marcelo Henrique

Vinicius Romariz

Pedro Pepeu

Gustavo Pereira

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published