Git Product home page Git Product logo

r8mytalk's Introduction

CS510Project

About

This project is for Parents2Partners, developed by students of CCSU. This project is intended to be iterated on through multiple classes of student developers. This repo is a fork of the previous development team. Their upstream code base can be found here: https://github.com/Gulloje/R8MyTalkGulloje/R8MyTalk

If you are a future developer of this project, please fork this repo and continue development. There is no need to submit your changes upstream to this repo, though feel free to reach out to us with questions about the project. The previous developer provided us with a word document user manual that we will share with you.

The production application can be viewed here: https://r8temytalk-nkqs.onrender.com/ It is using a free hosting plan, and is normal for it to be slow to start up

Prerequisites

Build a dev environment

Follow these steps to set up a local development environment:

  • create a folder that you want to use as your project directory
  • cd to your project directory in a terminal
  • clone the repo
git clone https://github.com/shawnmuzick/R8MyTalk.git
  • dump the env file into the root of the cloned project, on the same level as this readme. Make sure the file is named ".env", if it is not.
  • run the command to install the packages for the project:
npm install
  • when the dependencies are finished installing, you can invoke node from a terminal and call the main application entry point:
node index.js
  • the application will run on port 3000, by default. View the running application in your browser at localhost:3000

Contributing

Branching Strategy

We will follow a conventional branching strategy:

main
|
- dev
|	|
|	- feat-{nameOfFeature}
|	- feat-{nameOfFeature}
|	- feat-{nameOfFeature}
|
- hotfix

When implementing a new feature, please create a branch from dev named as "feat-{nameOfFeature}". When the feature is complete, please submit a pull request into dev. The code will be reviewed and merged pending approval.

Main will be linked with the production environment.

Commit Messages

Please use conventional message prefixes:

feat		– new feature
fix			– bug fix
chore		– bump dependencies, update docs, etc
refactor	– refactoring code
test 		– create new tests or fix existing ones
revert 		– revert some previous commit

Linter Settings

BiomeJS is used as the linter for this project. You can check the configuration in biome.json Of note, the noForEach rule is disabled. The is beause the ForEach method used on FireBase objects is a cutom method on that object by the module developers (Google). They are not iterable by the language, and thus for...of will fail.

r8mytalk's People

Contributors

shawnmuzick avatar emilioespada avatar alriyashi avatar gulloje avatar

r8mytalk's Issues

Contacts Page/Report

"As a Speaker, I want to download contact info from Attendees, so that I can invite them to future talks. "

Write a feature to display and download a report of contact information.

Wordpress Promotional site

Complete the following:

  • install/set up the new WordPress site on the hosting plan
  • create the single landing page with the sections described in previous deliverables
  • insert the copy text/content provided by the PO

Profile Page

" As a Speaker, I want to create a profile page, so that Attendees can find me on the app. "

Write a feature to display a profile page for a speaker, including an image and a short bio.

Feedback reports

"As a Speaker, I want to view/download feedback reports, so that I can review and improve my skills. "

Write a feature to display feedback reports and create a downloadable report.

Speaker Profile Social Links

"As a Speaker, I want to add social links to my profile page, so that Attendees can find me online."

Write a feature to include social links on the speaker profile pages.
Prerequisite: complete the feature described in #4

Update Application Logo

" As a Speaker, I want my company's logo updated on the app, so that our brand is well represented"

Update the logo displayed on the application

Update app color scheme

"As a Speaker, I want the app’s color scheme updated, so that text is easier for Attendees to read. "

Update the application color scheme to a lighter theme (light bg, dark text) to increase legibility.

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.