Skip to content

Commit

Permalink
Created the basic project setup
Browse files Browse the repository at this point in the history
  • Loading branch information
TheNaubit committed Nov 16, 2022
1 parent 13678b5 commit f8d5325
Show file tree
Hide file tree
Showing 5 changed files with 67 additions and 28,692 deletions.
6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,9 @@
npm-debug.log*
yarn-debug.log*
yarn-error.log*

# My own ignores
pnpm-lock.yaml
/.yarn
yarn.lock
package-lock.json
67 changes: 21 additions & 46 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,21 @@
# Getting Started with Create React App

This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).

## Available Scripts

In the project directory, you can run:

### `npm start`

Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.

The page will reload if you make edits.\
You will also see any lint errors in the console.

### `npm test`

Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.

### `npm run build`

Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!

See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.

### `npm run eject`

**Note: this is a one-way operation. Once you `eject`, you can’t go back!**

If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

## Learn More

You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).

To learn React, check out the [React documentation](https://reactjs.org/).
# 🤖 Demo Random Users
A little example where you can see a list of users (random, obtained from a random API) and also the details of each specific users (including a map location). The project uses React.js (started the project with CRA), Typescript, React Query, MUI, React Context (with a small library to use it with hooks easily), and Open Layers.

![]()

## Live Demo
You can check this project deployed here: []()

## Stack Used
- React.js (created with CRA)
- Typescript
- MUI
- React Query
- React Context
- Open Layers
- And much more! 🚀

## How to install and run by yourself?
- Clone this repo in your computer and inside the root folder of this project, install the libraries (you can use ```npm i```, ```yarn``` or even ```pnpm i```)
- Once the libraries are installed, launch the project with ```npm run dev```, ```yarn dev``` or ```pnpm run dev```
- That's it!
Loading

0 comments on commit f8d5325

Please sign in to comment.