YehosuaEs/ita-directory

ITA directory project for Barcelona Activa - IT Acacdemy students.

IT Academy Directory

IT Academy Directory is a project built with React.js and Node.js for students at the IT Academy from Barcelona Activa. The goal is to allow them to familiarize themselves with a generic development setup that could be found in other places. One of the purposes of this project is to allow students to deal with new features, legacy code, fixes and teamwork challenges. As a consequence the priority is not only excellent technical execution, but to provide a full learning experience to our students.
Explore the docs »

Visual design · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
   • Swagger Docs
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

![Product Name Screen Shot][product-screenshot]

Here's a blank template to get started: To avoid retyping too much info. Do a search and replace with your text editor for the following: github_username, repo_name, twitter_handle, email, project_title, project_description

Built With

• React
• Nodejs
• PostgreSQL
• Redis

Requirements

1. Docker
2. Bash terminal
3. Git pull-request and issue flows.

How to work with GIT

1. When new features or fixes are required we create a new issue.
2. Issues are assigned to one person.
3. The number of the issue is created as a new branch name following git branch naming conventions: https://deepsource.io/blog/git-branch-naming-conventions/
4. Once the issue is resolved, a new pull-request from your branch to development is required.

Project files:

1. This repository
2. Visual: Visual design

Getting Started

To get a local copy up and running follow these simple steps.

1. Clone the repository: git clone https://github.com/it-academyproject/ita-directory.git
2. Checkout to the develop branch, we don't work from main: git checkout develop
3. TEMPORARY STEP: Copy the .env.development file to a new .env in the root directory and .env in the ./backend directory.
4. Install dependencies with: npm run install-deps It installs the dependencies of the front, the back and the main directory
5. Make sure that you have docker installed and running, and from the main folder launch up: npm run up

The up command will:

• Start PostgreSQL
• Start Redis
• Generate PRISMA migrations
• Seed the Postgres database

6. Once all of it is up and running launch the backend, to enable the API and the frontend if necessary

npm run backend npm run frontend

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/it-academyproject/ita-directory.git

2. Install NPM packages

   npm install

Swagger Docs

Once you have started the server, then you can open your browser and enter this endpoint /api-docs/ to the server URL to open the swagger documentation.

-example

http://localhost:5000/api-docs/

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Your Name - @twitter_handle - email

Project Link: https://github.com/github_username/repo_name

Acknowledgements