Git Product home page Git Product logo

codigomx-app's Introduction

codigomx-app

Simple blogging site that allows users to submit blog posts and reply to exsisting posts.

Getting Started

Clone or download this repository and follow the subsequent instructions in order to get the project up and running

Prerequisites

In order to run this project the most recent version of nodejs and npm must be installed.

Node.js and npm packages are available from the Ubuntu 18.04 distribution repository

sudo apt install nodejs npm

You can check if you have nodejs and npm instaleld by issuing the following commands:

nodejs -v
npm -v

Running

Here are the steps to get a development env running

1.First the backend must be running. To do so navigate into the backend folder, install the dependencies, and execute the start script

cd backend
npm install
npm start

This script will execute nodemon with the env variables set in the nodemon.json file(PORT by default is 5000). This makes for easier deployment which is mentioned later on.

2.In order to run the development server navigate into the client folder, install the dependencies, and excute the start script

cd client
npm install
npm start

This script will start the development server on the default port(PORT 3000)

Now you can interact with the client by navigating onto localhost:3000 and interact with the backend by navigating onto localhost:5000

Deployment

In order to deploy the backend to a server set the following environment variables:

PORT:<PORTNUMBER>
MONGO_ADMIN_PW: <MONGO ADMINISTRATOR PASSWORD>

Built With

  • REACT - The front-end framework used
  • REDUX - Framework used to manage state
  • NODE - Run-time environment used for the backend
  • MONGO ATLAS - Used to generate our database (DaaS)

Authors

codigomx-app's People

Contributors

agalin920 avatar

Watchers

James Cloos avatar  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.