Skip to content

Latest commit

 

History

History
198 lines (188 loc) · 5.81 KB

README.md

File metadata and controls

198 lines (188 loc) · 5.81 KB
Raw

Tech Titans1

TechTitans-React/Node-Drink Master



Project Description



This project was created by Tech Titans to demonstrate the basic knowledge of Node + React, a popular combination for building server-side rendered and static websites. The focus of this test is to showcase understanding of fundamentals, including routing, data fetching, and component composition.
Link to BackEnd repository



Technology that have been used:



  • React
  • Redux
  • Redux Toolkit
  • MUI
  • Styled-components
  • JS ES6+
  • Node.js
  • REST API


Project code example:



giphy 1

giphy 1

giphy 1

giphy 1

giphy 1

giphy 1

giphy 1

giphy 1



Project Structure



The project structure is organized as follows:

  • Api/ # Contains all api connection settings
  • Assets/ # Contains all images and icons that was used in the project
  • Components/ # Contains reusable components used throughout the application
  • Constants/ # Contains all CONST project data
  • Hooks/ # Contains all useful hooks that was used in the project
  • Pages/ # Contains the pages
  • Redux/ # Contains all project redux logic
  • Routes/ # Contains all route settings
  • Theme/ # Contains all theme project data
  • Utils/ # Contains all utility`s
  • Package.json # Project dependencies and scripts
  • README.md # Project documentation (you are here)


Getting Started



To get started with the project, follow these steps:



Navigate to the project directory:

  • Git bash
  • Copy the code
  • cd ~/Desktop/TeamName-project
  • Install the dependencies
  • Copy the code
  • npm install
  • Start the development server [npm run start]


Arduino



  • Copy the code
  • npm run dev
  • Open your browser and visit http://localhost:3000/TeamName-project/ to see the application


Available Scripts



In the project directory, you can run the following scripts:

  • npm run start: Starts the development server on http://localhost:3000/TeamName-project/
  • npm run build: Builds the application for production.
  • npm run lint:js: Runs the linter to check for code quality issues


Contributing



If you`d like to contribute to this project, you can follow these steps:

  • For the repository on GitHub
  • Clone your forked repository to your local machine
  • Create a new branch for your changes
  • Make your modifications and additions in the new branch
  • Push your branch to your forked repository
  • Submit a pull request to the original repository


Main functionality



The main functionality and purpose of the application is to create an authorization / registration system. The database must also be connected in order for the user to be stored in it. Various checks must be implemented so that the same users cannot be registered.



A database of cocktails should be created. They must be able to be added/taken from the database. It should be possible to add cocktail recipes to favorites. Each profile (account) should have its favorites. Recipes created by other users should be visible to other users (shown / included in the general database of recipes).



Add the ability to add your recipes, with different recipes, photos, descriptions. Add mechanism for "Popular" recipes. Implement a component that would show 4 of the popular recipes.



Bind any interactions either to the redux or to the backend. Bind all the necessary components to the database and the state. Use the latest technologies (hooks, es6+, code cleanup and beauty)



License



This project is licensed under the MIT License



Acknowledgments



This project was created for practise purpose. Created an own backend for more comfortable using of the application. Super reusable code, components - based, pretty structure.