Giter Club home page Giter Club logo

estate-explorer-web's Introduction

Estate Explorer

Welcome to the frontend of the Estate Explorer app. This is a proof of concept for building an application using Wordpress as a headless CMS. You can check the backend here and the live version here.

Technologies

This project has been developed using NextJs with the new stable app folder.

For the styling solution I chose Linaria, which is a zero runtime css in js solution. Unfortunately theres no official support for the NextJs framework, so I had to use the third party library next-with-linaria.

This library is the one which supports NextJs 13 (app folder) and Linaria v4, but its still in development, so I had some issues that delayed the development, like this one, and also the fact that sometimes the styles don't update on the page when saving the file.

I could've used Tailwind as it's recommended by NextJs team and pretty easy to work with, but I wanted to experiment with Linaria as it's similar to a solution that I'm used to: styled components, with the advantage of being zero runtime (no transpilation involved).

For testing I chose a well-known robust and stable setup: Cypress (E2E), Jest + RTL (Unit/Integration). As this is a PoC I decided to write tests for the main features, not focusing on a lot of tests with high coverage.

Getting Started

  1. Install the dependencies
npm install
  1. Make a copy of the .env.example file, name it .env.local and fill with your values.
Variable Description
NEXT_PUBLIC_WP_HOST_URL The REST API url of your Wordpress site (example: http://site.local/wp-json/wp/v2)
WP_IMAGES_HOST Only the host part of your site. This will be used to allow images for the next/image component (example: site.local).
  1. Run the development server
npm run dev

estate-explorer-web's People

Contributors

luizeboli avatar

Stargazers

 avatar

Watchers

 avatar

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.