Coder Social home page Coder Social logo

luuanfaria / clone-tabnews Goto Github PK

View Code? Open in Web Editor NEW
1.0 0.0 0.0 100 KB

This project replicates features from https://www.tabnews.com.br on https://curso.dev, with the main goal of enhancing technical programming skills.

Home Page: https://clone-tabnews-kappa-lemon.vercel.app

JavaScript 100.00%

clone-tabnews's Introduction

Project Setup Instructions

This repository contains scripts to facilitate the development and testing process of a project using Docker Compose and npm scripts. Follow the instructions below to set up and run the project.

Prerequisites

Getting Started

  1. Clone this repository to your local machine.
git clone [email protected]:luuanfaria/clone-tabnews.git
  1. Navigate to the project directory.
cd clone-tabnews
  1. Install project dependencies.
npm install

Available Scripts

1. Start Development Server

To start the development server and bring up the required services using Docker Compose, run:

npm run dev

This command will start the necessary services defined in the infra/compose.yaml file using Docker Compose and then start the development server.

2. Stop Services

To stop the running services, run:

docker-compose stop

3. Shut Down Services

To stop and remove the services, run:

docker-compose down

4. Check Code Style

To check the code style using Prettier, run:

npm run lint:check

5. Fix Code Style

To automatically fix code style issues using Prettier, run:

npm run lint:fix

6. Run Tests

To run tests using Jest, run:

npm test

7. Run Tests in Watch Mode

To run tests in watch mode using Jest, run:

npm run test:watch

Notes

  • Ensure that Docker is installed and running on your machine before starting the development server.
  • Make sure to run docker-compose up before starting the development server (npm run dev).

Follow these instructions to get started with the project. If you encounter any issues, refer to the error messages or feel free to reach out for assistance. Happy coding!

clone-tabnews's People

Contributors

luanfariaf avatar

Stargazers

Diego Amaral avatar

clone-tabnews's Issues

Database (Local)

  • Create /status endpoint
  • Upload Local Database
  • Create database.js module
  • Move .env to .env.development
  • Add jsconfig.json with baseUrl
  • Add scripts of services
  • Done with endpoint /status return

Migrations

  • Run migrations by code line
  • Run migrations with endpoint /migrations

Architecture proposal and folders

๐Ÿ“ฆ root
โ”œโ”€ ๐Ÿ“ pages
โ”‚  โ”œโ”€ ๐Ÿ“„ index.js
โ”œโ”€ ๐Ÿ“ models
โ”‚  โ”œโ”€ ๐Ÿ“„ user.js
โ”‚  โ”œโ”€ ๐Ÿ“„ content.js
โ”‚  โ”œโ”€ ๐Ÿ“„ password.js
โ”œโ”€ ๐Ÿ“ infra
โ”‚  โ”œโ”€ ๐Ÿ“„ database.js
โ”‚  โ”œโ”€ ๐Ÿ“ migrations
โ”‚  โ”œโ”€ ๐Ÿ“ provisioning
โ”‚  โ”‚  โ”œโ”€ ๐Ÿ“ staging
โ”‚  โ”‚  โ”œโ”€ ๐Ÿ“ production
โ”œโ”€ ๐Ÿ“ tests

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.