search

tbf-challenge / teamwork-be

This is the backend repository for teamwork
0 stars 0 forks source link

readme

Teamwork

Description

Project Overview Teamwork is an ​ internal social network for employees of an organization. The goal of this application is to facilitate more interaction between colleagues and promote team bonding. An in-depth paragraph about your project and overview of use.

Getting Started

Dependencies

Installing

  1. Clone the repo

    git clone https://github.com/your_username_/Project-Name.git

  2. Install NPM packages

    npm install

  3. Create a .env file .env and update with env variables (check the .env.sample)

  4. To run the test locally for the project, create a file called .env.test and update it with test env variables (check the .env.sample). PS. i. The .env.test contains the env variables for the test environment ii. Ensure that you use a different database name in the .env.test. This is because in the test environment the database will always be dropped.

    <p align="right">(<a href="#top">back to top</a>)</p>

Executing program

  1. npm run dev Runs the app in the development mode.\

The page will reload when you make changes.\ You may also see any lint errors in the console.

  1. npm test Launches the test runner in the interactive watch mode.\

  2. npm run seeddb seeds the database with users data.\

Help

Any advise for common problems or issues.

How do I add a new migration?

For context, a migration is basically a file that is run to make changes to the existing database structure or schema. For example, adding a new column, making a column required/optional/unique, dropping a column, inserting data and more.

To create a new migration. Kindly follow the steps outlined below:

  1. Create a migration and name it to suit what the migration will be doing. This is done by running
npm run migrate create {migration-name}

NB: Change {migration-name} to the actual name of the migration. The name should represent the change you're making so it is readable. See the existing names in the migrations folder

  1. A new migration file will be created.
  2. The content of the migration to be added will depend mainly on the task being done. Here is a guide which shows how to define the migration based on the specific task in question.
  3. After the migration is properly defined, starting the server should run the new migration and effect the corresponding changes in the database.

Authors

Contributors names and contact info

ex. Dominique Pizzie
ex. @DomPizzie

Version History

Built With

This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

This project is licensed under the [NAME HERE] License - see the LICENSE.md file for details

Acknowledgments

Inspiration, code snippets, etc.