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
![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
- Docker
- Bash terminal
- Git pull-request and issue flows.
- When new features or fixes are required we create a new issue.
- Issues are assigned to one person.
- 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/
- Once the issue is resolved, a new pull-request from your branch to main is required.
- This repository
- Visual: Visual design
To get a local copy up and running follow these simple steps.
- Clone the repository:
git clone https://github.com/it-academyproject/ita-directory.git - Install dependencies with:
npm run install-depsIt installs the dependencies of the front, the back and the main directory - Make sure that you have docker installed and running, and from the main folder launch up:
npm run up(to initialize the local project in docker) - Create a .vscode folder in the root directory. It won't be shared on git as it is ignored.
- Create a settings.json inside the .vscode file with the following content:
{
"eslint.workingDirectories": ["frontend", "backend"]
}
The code above allows the ESLint VSCode extension to properly find each ESLint project configuration file.
The up command will:
- Start PostgreSQL
- Start Redis
- Generate PRISMA migrations
- Seed the Postgres database
-
Once all of it is up and running launch the backend, to enable the API
npm run backend -
Open another terminal and launch the frontend with the command:
npm run frontend
-
Now the project is setup and running on local enviroment.
-
In order to start contributing to the project and solvieng issues you must create and change to new branch for the issue number (#id) and the issue name, never work on main branch.
git checkout -b issueNumber-name-of-issue
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
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:10910/api-docs/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
See the open issues for a list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request 5.1 Use a Closing Keyword to link your Pull request to an Issue