Code Monkey home page Code Monkey logo

finally-seen's Introduction

FINALLY-SEEN

A contribution initiative


STACK

  • Client:
    • React with CRA templated with TS
  • Server:
    • NodeJS and Express
  • DB:
    • MongoDB
  • Deployment:
    • Render.io

The Project:

Hello World! And welcome to FINALLY-SEEN, a soon to be a MERN stack application for which a user (a dev) will be able to post the URL of their portfolio and obtain some sort of feedback.

The Project is still to be fully defined, I just wanted to get that out there as soon as possible to help those like me who chase "good first issue"s.

The intention is to get everyone who wants to contribute, at least one task. I will personally try my best to adapt this project so anyone regardless of skills can hop in.

Ex: You know react but do not know TS...No problem. Ill take your JS (thanks for that) and give the convertion to someone else to collab on.


Fearful? Don't be...

While I intend to give devs a good amount of coding freedom, I will be very specific and even (if needed and requested), outline steps needed to be performed in order to achieve the task. IT'S OKAY TO MAKE MISTAKES. Fixing bugs always make great first issues.

WHAT IS NOT OKAY?

Leave your ego home. This industry is full of it and I'm sure you can find plenty of opportunities to take it "for a walk". This is not the place.


HOW TO RUN?

  1. Fork this repo:

    Step 1: Click the Fork button to the right of the repository. image Step 2: We will then be navigated to the create new a fork page and click the create fork button. image

  2. Clone the project:

    Step 1: On your Visual Studio Code IDE (or any IDE), click terminal and click new terminal. image Step 2: On the terminal run git clone https://github.com/Medic1111/FINALLY-SEEN to clone the project.

  3. Install dependencies client and run client:

    Step 1: On the terminal in your VScode IDE run cd .\FINALLY-SEEN\

    Step 2: Then run cd .\client\ and run npm install to install dependencies client.

    Step 3: With all dependencies installed, while still on the client you can run npm start to start the client on localhost 3000

  4. Install dependencies server and run server:

    Step 1: On the new terminal in your VScode IDE(while on the root of the project) run cd .\server\

    Step 2: Then run npm install to install dependencies server.

    Step 3: With all dependencies installed, while still on the server you can run node app.js to start the server.

I highly suggest using nodemon to run the server. It is not a dependency of this project but feel free to use your globally installed one.


WHO AM I

๐Ÿ‘‰ Aryse Tansy ๐Ÿ“ง [email protected] ๐Ÿ’ป Portfolio


finally-seen's People

Contributors

medic1111 avatar cngsu 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.